Class: Stigg::Models::V1::EventReportParams::Event

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/event_report_params.rb

Defined Under Namespace

Modules: Dimension

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(events:, request_options: {}) ⇒ Object

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 22

class Event < Stigg::Internal::Type::BaseModel
  # @!attribute customer_id
  #   Customer id
  #
  #   @return [String]
  required :customer_id, String, api_name: :customerId

  # @!attribute event_name
  #   The name of the usage event
  #
  #   @return [String]
  required :event_name, String, api_name: :eventName

  # @!attribute idempotency_key
  #   Idempotency key
  #
  #   @return [String]
  required :idempotency_key, String, api_name: :idempotencyKey

  # @!attribute dimensions
  #   Dimensions associated with the usage event
  #
  #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
  optional :dimensions,
           -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::EventReportParams::Event::Dimension] }

  # @!attribute resource_id
  #   Resource id
  #
  #   @return [String, nil]
  optional :resource_id, String, api_name: :resourceId, nil?: true

  # @!attribute timestamp
  #   Timestamp
  #
  #   @return [Time, nil]
  optional :timestamp, Time

  # @!method initialize(customer_id:, event_name:, idempotency_key:, dimensions: nil, resource_id: nil, timestamp: nil)
  #   Raw usage event
  #
  #   @param customer_id [String] Customer id
  #
  #   @param event_name [String] The name of the usage event
  #
  #   @param idempotency_key [String] Idempotency key
  #
  #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Dimensions associated with the usage event
  #
  #   @param resource_id [String, nil] Resource id
  #
  #   @param timestamp [Time] Timestamp

  module Dimension
    extend Stigg::Internal::Type::Union

    variant String

    variant Float

    variant Stigg::Internal::Type::Boolean

    # @!method self.variants
    #   @return [Array(String, Float, Boolean)]
  end
end

Instance Attribute Details

#customer_id ⇒ String

Customer id

Returns:

  • (String) 


27
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 27

required :customer_id, String, api_name: :customerId

#dimensions ⇒ Hash{Symbol=>String, Float, Boolean}?

Dimensions associated with the usage event

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


45
46
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 45

optional :dimensions,
-> { Stigg::Internal::Type::HashOf[union: Stigg::V1::EventReportParams::Event::Dimension] }

#event_name ⇒ String

The name of the usage event

Returns:

  • (String) 


33
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 33

required :event_name, String, api_name: :eventName

#idempotency_key ⇒ String

Idempotency key

Returns:

  • (String) 


39
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 39

required :idempotency_key, String, api_name: :idempotencyKey

#resource_id ⇒ String?

Resource id

Returns:

  • (String, nil) 


52
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 52

optional :resource_id, String, api_name: :resourceId, nil?: true

#timestamp ⇒ Time?

Timestamp

Returns:

  • (Time, nil) 


58
 
# File 'lib/stigg/models/v1/event_report_params.rb', line 58

optional :timestamp, Time