Class: VoucherifySdk::ManagementProjectsCreateRequestBody

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/management_projects_create_request_body.rb

Overview

Request body schema for POST ‘/management/v1/projects`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementProjectsCreateRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



178
179
180
181
182
183
184
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 178

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

  if attributes.key?(:'webhook_version')
    self.webhook_version = attributes[:'webhook_version']
  else
    self.webhook_version = 'v2024-01-01'
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'api_version')
    self.api_version = attributes[:'api_version']
  else
    self.api_version = 'v2018-08-01'
  end

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

Instance Attribute Details

#api_usage_notifications ⇒ Object

Returns the value of attribute api_usage_notifications.



63
64
65
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 63

def api_usage_notifications
  @api_usage_notifications
end

#api_version ⇒ Object

The API version used in the project. Currently, the default and only value is ‘v2018-08-01`.



69
70
71
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 69

def api_version
  @api_version
end

#case_sensitive_codes ⇒ Object

Determines if the vouchers in the project will be case sensitive (if ‘true`, `C0dE-cfV` is not equal to `c0de-cfv`) or case insensitive (if false, `C0dE-cfV` is equal to `c0de-cfv`).



20
21
22
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 20

def case_sensitive_codes
  @case_sensitive_codes
end

#client_create_customer_enabled ⇒ Object

Enables client-side creation of customers.



53
54
55
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 53

def client_create_customer_enabled
  @client_create_customer_enabled
end

#client_list_vouchers_enabled ⇒ Object

Enables client-side listing of vouchers.



50
51
52
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 50

def client_list_vouchers_enabled
  @client_list_vouchers_enabled
end

#client_loyalty_events_enabled ⇒ Object

Enables client-side events for loyalty and referral programs.



56
57
58
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 56

def client_loyalty_events_enabled
  @client_loyalty_events_enabled
end

#client_publish_enabled ⇒ Object

Enables client-side publication.



47
48
49
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 47

def client_publish_enabled
  @client_publish_enabled
end

#client_redeem_enabled ⇒ Object

Enables client-side redemption.



44
45
46
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 44

def client_redeem_enabled
  @client_redeem_enabled
end

#client_set_voucher_expiration_date_enabled ⇒ Object

Enables client-side setting of voucher expiration date.



59
60
61
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 59

def client_set_voucher_expiration_date_enabled
  @client_set_voucher_expiration_date_enabled
end

#client_trusted_domains ⇒ Object

An array of URL addresses that allow client requests.



41
42
43
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 41

def client_trusted_domains
  @client_trusted_domains
end

#cluster_id ⇒ Object

The identifier of the cluster where the project will be created. The default cluster is ‘eu1` unless otherwise configured.



66
67
68
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 66

def cluster_id
  @cluster_id
end

#currency ⇒ Object

The currency used in the project. It is equal to a 3-letter ISO 4217 code.



32
33
34
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 32

def currency
  @currency
end

#description ⇒ Object

A user-defined description of the project, e.g. its purpose, scope, region.



26
27
28
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 26

def description
  @description
end

#dial_code ⇒ Object

The country dial code for the project. It is equal to an ITU country code.



35
36
37
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 35

def dial_code
  @dial_code
end

#name ⇒ Object

The name of the project.



23
24
25
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 23

def name
  @name
end

#timezone ⇒ Object

The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.



29
30
31
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 29

def timezone
  @timezone
end

#users ⇒ Object

The users (their identifiers, logins, and roles) who will be assigned to the project. You can assign only existing Voucherify users. It must be used either in the following combinations: - ‘id` and `role`, or - `login` and `role`.



72
73
74
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 72

def users
  @users
end

#webhook_version ⇒ Object

The webhook version used in the project.



38
39
40
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 38

def webhook_version
  @webhook_version
end

#webhooks_callout_notifications ⇒ Object

Returns the value of attribute webhooks_callout_notifications.



61
62
63
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 61

def webhooks_callout_notifications
  @webhooks_callout_notifications
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



353
354
355
356
357
358
359
360
361
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
388
389
390
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 353

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 97

def self.attribute_map
  {
    :'case_sensitive_codes' => :'case_sensitive_codes',
    :'name' => :'name',
    :'description' => :'description',
    :'timezone' => :'timezone',
    :'currency' => :'currency',
    :'dial_code' => :'dial_code',
    :'webhook_version' => :'webhook_version',
    :'client_trusted_domains' => :'client_trusted_domains',
    :'client_redeem_enabled' => :'client_redeem_enabled',
    :'client_publish_enabled' => :'client_publish_enabled',
    :'client_list_vouchers_enabled' => :'client_list_vouchers_enabled',
    :'client_create_customer_enabled' => :'client_create_customer_enabled',
    :'client_loyalty_events_enabled' => :'client_loyalty_events_enabled',
    :'client_set_voucher_expiration_date_enabled' => :'client_set_voucher_expiration_date_enabled',
    :'webhooks_callout_notifications' => :'webhooks_callout_notifications',
    :'api_usage_notifications' => :'api_usage_notifications',
    :'cluster_id' => :'cluster_id',
    :'api_version' => :'api_version',
    :'users' => :'users'
  }
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 329

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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 152

def self.openapi_nullable
  Set.new([
    :'case_sensitive_codes',
    :'name',
    :'description',
    :'timezone',
    :'currency',
    :'dial_code',
    :'webhook_version',
    :'client_trusted_domains',
    :'client_redeem_enabled',
    :'client_publish_enabled',
    :'client_list_vouchers_enabled',
    :'client_create_customer_enabled',
    :'client_loyalty_events_enabled',
    :'client_set_voucher_expiration_date_enabled',
    :'webhooks_callout_notifications',
    :'api_usage_notifications',
    :'cluster_id',
    :'api_version',
    :'users'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 127

def self.openapi_types
  {
    :'case_sensitive_codes' => :'Boolean',
    :'name' => :'String',
    :'description' => :'String',
    :'timezone' => :'String',
    :'currency' => :'String',
    :'dial_code' => :'String',
    :'webhook_version' => :'String',
    :'client_trusted_domains' => :'Array<String>',
    :'client_redeem_enabled' => :'Boolean',
    :'client_publish_enabled' => :'Boolean',
    :'client_list_vouchers_enabled' => :'Boolean',
    :'client_create_customer_enabled' => :'Boolean',
    :'client_loyalty_events_enabled' => :'Boolean',
    :'client_set_voucher_expiration_date_enabled' => :'Boolean',
    :'webhooks_callout_notifications' => :'ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications',
    :'api_usage_notifications' => :'ManagementProjectsCreateRequestBodyApiUsageNotifications',
    :'cluster_id' => :'String',
    :'api_version' => :'String',
    :'users' => :'Array<ManagementProjectsCreateRequestBodyUsersItem>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      case_sensitive_codes == o.case_sensitive_codes &&
      name == o.name &&
      description == o.description &&
      timezone == o.timezone &&
      currency == o.currency &&
      dial_code == o.dial_code &&
      webhook_version == o.webhook_version &&
      client_trusted_domains == o.client_trusted_domains &&
      client_redeem_enabled == o.client_redeem_enabled &&
      client_publish_enabled == o.client_publish_enabled &&
      client_list_vouchers_enabled == o.client_list_vouchers_enabled &&
      client_create_customer_enabled == o.client_create_customer_enabled &&
      client_loyalty_events_enabled == o.client_loyalty_events_enabled &&
      client_set_voucher_expiration_date_enabled == o.client_set_voucher_expiration_date_enabled &&
      webhooks_callout_notifications == o.webhooks_callout_notifications &&
      api_usage_notifications == o.api_usage_notifications &&
      cluster_id == o.cluster_id &&
      api_version == o.api_version &&
      users == o.users
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 424

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


316
317
318
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 316

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



322
323
324
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 322

def hash
  [case_sensitive_codes, name, description, timezone, currency, dial_code, webhook_version, client_trusted_domains, client_redeem_enabled, client_publish_enabled, client_list_vouchers_enabled, client_create_customer_enabled, client_loyalty_events_enabled, client_set_voucher_expiration_date_enabled, webhooks_callout_notifications, api_usage_notifications, cluster_id, api_version, users].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



271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 271

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



400
401
402
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 400

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 406

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



394
395
396
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 394

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



279
280
281
282
283
284
285
286
 
# File 'lib/VoucherifySdk/models/management_projects_create_request_body.rb', line 279

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  webhook_version_validator = EnumAttributeValidator.new('String', ["v2024-01-01"])
  return false unless webhook_version_validator.valid?(@webhook_version)
  api_version_validator = EnumAttributeValidator.new('String', ["v2018-08-01"])
  return false unless api_version_validator.valid?(@api_version)
  true
end