Class: Amocrm::Models::CustomerSegmentCreateParams::Body

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/amocrm/models/customer_segment_create_params.rb

Defined Under Namespace

Classes: CustomFieldsValue

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(body:, request_options: {}) ⇒ Object

Parameters:



19
20
21
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/amocrm/models/customer_segment_create_params.rb', line 19

class Body < Amocrm::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String]
  required :name, String

  # @!attribute color
  #
  #   @return [String, nil]
  optional :color, String

  # @!attribute custom_fields_values
  #
  #   @return [Array<Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue>, nil]
  optional :custom_fields_values,
           -> { Amocrm::Internal::Type::ArrayOf[Amocrm::CustomerSegmentCreateParams::Body::CustomFieldsValue] }

  # @!attribute request_id
  #
  #   @return [String, nil]
  optional :request_id, String

  # @!method initialize(name:, color: nil, custom_fields_values: nil, request_id: nil)
  #   @param name [String]
  #   @param color [String]
  #   @param custom_fields_values [Array<Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue>]
  #   @param request_id [String]

  class CustomFieldsValue < Amocrm::Internal::Type::BaseModel
    # @!attribute values
    #   Values for the field (multiple values allowed)
    #
    #   @return [Array<Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue::Value>]
    required :values,
             -> { Amocrm::Internal::Type::ArrayOf[Amocrm::CustomerSegmentCreateParams::Body::CustomFieldsValue::Value] }

    # @!attribute field_code
    #   Field code (e.g. PHONE/EMAIL)
    #
    #   @return [String, nil]
    optional :field_code, String

    # @!attribute field_id
    #   Use either field_id or field_code (e.g. PHONE/EMAIL)
    #
    #   @return [Integer, nil]
    optional :field_id, Integer

    # @!method initialize(values:, field_code: nil, field_id: nil)
    #   @param values [Array<Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue::Value>] Values for the field (multiple values allowed)
    #
    #   @param field_code [String] Field code (e.g. PHONE/EMAIL)
    #
    #   @param field_id [Integer] Use either field_id or field_code (e.g. PHONE/EMAIL)

    class Value < Amocrm::Internal::Type::BaseModel
      # @!attribute value
      #
      #   @return [String, Integer, Boolean]
      required :value, union: -> { Amocrm::CustomerSegmentCreateParams::Body::CustomFieldsValue::Value::Value }

      # @!attribute enum_code
      #   Option code for list/select custom fields (if you use code instead of id)
      #
      #   @return [String, nil]
      optional :enum_code, String

      # @!attribute enum_id
      #   Option id for list/select custom fields (one of predefined options)
      #
      #   @return [Integer, nil]
      optional :enum_id, Integer

      # @!method initialize(value:, enum_code: nil, enum_id: nil)
      #   @param value [String, Integer, Boolean]
      #
      #   @param enum_code [String] Option code for list/select custom fields (if you use code instead of id)
      #
      #   @param enum_id [Integer] Option id for list/select custom fields (one of predefined options)

      # @see Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue::Value#value
      module Value
        extend Amocrm::Internal::Type::Union

        variant String

        variant Integer

        variant Amocrm::Internal::Type::Boolean

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

Instance Attribute Details

#color ⇒ String?

Returns:

  • (String, nil) 


28
 
# File 'lib/amocrm/models/customer_segment_create_params.rb', line 28

optional :color, String

#custom_fields_values ⇒ Array<Amocrm::Models::CustomerSegmentCreateParams::Body::CustomFieldsValue>?

Returns:



33
34
 
# File 'lib/amocrm/models/customer_segment_create_params.rb', line 33

optional :custom_fields_values,
-> { Amocrm::Internal::Type::ArrayOf[Amocrm::CustomerSegmentCreateParams::Body::CustomFieldsValue] }

#name ⇒ String

Returns:

  • (String) 


23
 
# File 'lib/amocrm/models/customer_segment_create_params.rb', line 23

required :name, String

#request_id ⇒ String?

Returns:

  • (String, nil) 


39
 
# File 'lib/amocrm/models/customer_segment_create_params.rb', line 39

optional :request_id, String