incident_io_api 2.6.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 190b5a1426475cda97db4dad7e3c5b3cf88310ac31544673cc60c13ab0bd85e4
4
- data.tar.gz: 0fe3759593c773890ca6b405742e835dd100da217ca337db2b5a456386cdf955
3
+ metadata.gz: 88daae7a11ae6a22dace5ad124eebabc05b3f360c702994d827acced6173f38e
4
+ data.tar.gz: a2733e0e4f10772dbdef5d0523b851d50dfdbb02a22c06aa2caa3ff871610385
5
5
  SHA512:
6
- metadata.gz: 9a1ed7e10ac07b77a393b30f7a759372eabb2471ac2163014e219357788f2887c442da1d52a49734b0d877015e9b0be1b42c7714bfd0d204ec167217e7e58da7
7
- data.tar.gz: 4032a52c6ff3eaa0e3a831f2d190d0495c983346c1bbc37ad02a474e60f3c1d1f9f9e575b4b3efe54248a05f7dc508c603f27ec9586e7964f58ab120c75b1584
6
+ metadata.gz: 1e34e7a095212b9c326399810364c4e74c2785e6d40712beb33004614e9bf51938e78b5347668f543df4b14aa9cda3627a50af42f628bd522c1247cbb72edeff
7
+ data.tar.gz: 7079869a49eeedaa334271895d3d352caf479666116c4296d8db37e9a5611a9e5f83db8fe39b395da91513060ae2c10c7415acda05c318d1601a405559065517
@@ -952,7 +952,7 @@ module IncidentIo
952
952
  end
953
953
 
954
954
  # ShowStatusPageStructure Status Pages V2
955
- # Show the structure of a status page. This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
955
+ # Show the structure of a status page. This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
956
956
  # @param status_page_id [String] ID of the status page
957
957
  # @param [Hash] opts the optional parameters
958
958
  # @return [StatusPagesShowStatusPageStructureResultV2]
@@ -962,7 +962,7 @@ module IncidentIo
962
962
  end
963
963
 
964
964
  # ShowStatusPageStructure Status Pages V2
965
- # Show the structure of a status page. This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
965
+ # Show the structure of a status page. This endpoint requires a valid API key but no specific scopes. Returns the components and component groups configured on a status page, with their display settings, and how the page shows uptime. Use this to find component IDs when specifying affected components for incidents or maintenance windows.
966
966
  # @param status_page_id [String] ID of the status page
967
967
  # @param [Hash] opts the optional parameters
968
968
  # @return [Array<(StatusPagesShowStatusPageStructureResultV2, Integer, Hash)>] StatusPagesShowStatusPageStructureResultV2 data, response status code and response headers
@@ -18,6 +18,12 @@ module IncidentIo
18
18
  # The ID of the affected component. This may be found by calling the ShowStatusPageStructure endpoint.
19
19
  attr_accessor :component_id
20
20
 
21
+ # Whether the page shows this component's uptime
22
+ attr_accessor :display_uptime
23
+
24
+ # Whether the component is hidden from the page
25
+ attr_accessor :hidden
26
+
21
27
  # The name of this component
22
28
  attr_accessor :name
23
29
 
@@ -25,6 +31,8 @@ module IncidentIo
25
31
  def self.attribute_map
26
32
  {
27
33
  :'component_id' => :'component_id',
34
+ :'display_uptime' => :'display_uptime',
35
+ :'hidden' => :'hidden',
28
36
  :'name' => :'name'
29
37
  }
30
38
  end
@@ -43,6 +51,8 @@ module IncidentIo
43
51
  def self.openapi_types
44
52
  {
45
53
  :'component_id' => :'String',
54
+ :'display_uptime' => :'Boolean',
55
+ :'hidden' => :'Boolean',
46
56
  :'name' => :'String'
47
57
  }
48
58
  end
@@ -75,6 +85,18 @@ module IncidentIo
75
85
  self.component_id = nil
76
86
  end
77
87
 
88
+ if attributes.key?(:'display_uptime')
89
+ self.display_uptime = attributes[:'display_uptime']
90
+ else
91
+ self.display_uptime = nil
92
+ end
93
+
94
+ if attributes.key?(:'hidden')
95
+ self.hidden = attributes[:'hidden']
96
+ else
97
+ self.hidden = nil
98
+ end
99
+
78
100
  if attributes.key?(:'name')
79
101
  self.name = attributes[:'name']
80
102
  else
@@ -91,6 +113,14 @@ module IncidentIo
91
113
  invalid_properties.push('invalid value for "component_id", component_id cannot be nil.')
92
114
  end
93
115
 
116
+ if @display_uptime.nil?
117
+ invalid_properties.push('invalid value for "display_uptime", display_uptime cannot be nil.')
118
+ end
119
+
120
+ if @hidden.nil?
121
+ invalid_properties.push('invalid value for "hidden", hidden cannot be nil.')
122
+ end
123
+
94
124
  if @name.nil?
95
125
  invalid_properties.push('invalid value for "name", name cannot be nil.')
96
126
  end
@@ -103,6 +133,8 @@ module IncidentIo
103
133
  def valid?
104
134
  warn '[DEPRECATED] the `valid?` method is obsolete'
105
135
  return false if @component_id.nil?
136
+ return false if @display_uptime.nil?
137
+ return false if @hidden.nil?
106
138
  return false if @name.nil?
107
139
  true
108
140
  end
@@ -117,6 +149,26 @@ module IncidentIo
117
149
  @component_id = component_id
118
150
  end
119
151
 
152
+ # Custom attribute writer method with validation
153
+ # @param [Object] display_uptime Value to be assigned
154
+ def display_uptime=(display_uptime)
155
+ if display_uptime.nil?
156
+ fail ArgumentError, 'display_uptime cannot be nil'
157
+ end
158
+
159
+ @display_uptime = display_uptime
160
+ end
161
+
162
+ # Custom attribute writer method with validation
163
+ # @param [Object] hidden Value to be assigned
164
+ def hidden=(hidden)
165
+ if hidden.nil?
166
+ fail ArgumentError, 'hidden cannot be nil'
167
+ end
168
+
169
+ @hidden = hidden
170
+ end
171
+
120
172
  # Custom attribute writer method with validation
121
173
  # @param [Object] name Value to be assigned
122
174
  def name=(name)
@@ -133,6 +185,8 @@ module IncidentIo
133
185
  return true if self.equal?(o)
134
186
  self.class == o.class &&
135
187
  component_id == o.component_id &&
188
+ display_uptime == o.display_uptime &&
189
+ hidden == o.hidden &&
136
190
  name == o.name
137
191
  end
138
192
 
@@ -145,7 +199,7 @@ module IncidentIo
145
199
  # Calculates hash code according to all attributes.
146
200
  # @return [Integer] Hash code
147
201
  def hash
148
- [component_id, name].hash
202
+ [component_id, display_uptime, hidden, name].hash
149
203
  end
150
204
 
151
205
  # Builds the object from hash
@@ -18,6 +18,15 @@ module IncidentIo
18
18
  # Array of components belonging to this group
19
19
  attr_accessor :components
20
20
 
21
+ # A description shown under the group's name
22
+ attr_accessor :description
23
+
24
+ # Whether the page shows uptime aggregated across the group's components
25
+ attr_accessor :display_aggregated_uptime
26
+
27
+ # Whether the group is hidden from the page
28
+ attr_accessor :hidden
29
+
21
30
  # Unique ID of this component group
22
31
  attr_accessor :id
23
32
 
@@ -28,6 +37,9 @@ module IncidentIo
28
37
  def self.attribute_map
29
38
  {
30
39
  :'components' => :'components',
40
+ :'description' => :'description',
41
+ :'display_aggregated_uptime' => :'display_aggregated_uptime',
42
+ :'hidden' => :'hidden',
31
43
  :'id' => :'id',
32
44
  :'name' => :'name'
33
45
  }
@@ -47,6 +59,9 @@ module IncidentIo
47
59
  def self.openapi_types
48
60
  {
49
61
  :'components' => :'Array<StatusPageStructureComponentV2>',
62
+ :'description' => :'String',
63
+ :'display_aggregated_uptime' => :'Boolean',
64
+ :'hidden' => :'Boolean',
50
65
  :'id' => :'String',
51
66
  :'name' => :'String'
52
67
  }
@@ -82,6 +97,22 @@ module IncidentIo
82
97
  self.components = nil
83
98
  end
84
99
 
100
+ if attributes.key?(:'description')
101
+ self.description = attributes[:'description']
102
+ end
103
+
104
+ if attributes.key?(:'display_aggregated_uptime')
105
+ self.display_aggregated_uptime = attributes[:'display_aggregated_uptime']
106
+ else
107
+ self.display_aggregated_uptime = nil
108
+ end
109
+
110
+ if attributes.key?(:'hidden')
111
+ self.hidden = attributes[:'hidden']
112
+ else
113
+ self.hidden = nil
114
+ end
115
+
85
116
  if attributes.key?(:'id')
86
117
  self.id = attributes[:'id']
87
118
  else
@@ -104,6 +135,14 @@ module IncidentIo
104
135
  invalid_properties.push('invalid value for "components", components cannot be nil.')
105
136
  end
106
137
 
138
+ if @display_aggregated_uptime.nil?
139
+ invalid_properties.push('invalid value for "display_aggregated_uptime", display_aggregated_uptime cannot be nil.')
140
+ end
141
+
142
+ if @hidden.nil?
143
+ invalid_properties.push('invalid value for "hidden", hidden cannot be nil.')
144
+ end
145
+
107
146
  if @id.nil?
108
147
  invalid_properties.push('invalid value for "id", id cannot be nil.')
109
148
  end
@@ -120,6 +159,8 @@ module IncidentIo
120
159
  def valid?
121
160
  warn '[DEPRECATED] the `valid?` method is obsolete'
122
161
  return false if @components.nil?
162
+ return false if @display_aggregated_uptime.nil?
163
+ return false if @hidden.nil?
123
164
  return false if @id.nil?
124
165
  return false if @name.nil?
125
166
  true
@@ -135,6 +176,26 @@ module IncidentIo
135
176
  @components = components
136
177
  end
137
178
 
179
+ # Custom attribute writer method with validation
180
+ # @param [Object] display_aggregated_uptime Value to be assigned
181
+ def display_aggregated_uptime=(display_aggregated_uptime)
182
+ if display_aggregated_uptime.nil?
183
+ fail ArgumentError, 'display_aggregated_uptime cannot be nil'
184
+ end
185
+
186
+ @display_aggregated_uptime = display_aggregated_uptime
187
+ end
188
+
189
+ # Custom attribute writer method with validation
190
+ # @param [Object] hidden Value to be assigned
191
+ def hidden=(hidden)
192
+ if hidden.nil?
193
+ fail ArgumentError, 'hidden cannot be nil'
194
+ end
195
+
196
+ @hidden = hidden
197
+ end
198
+
138
199
  # Custom attribute writer method with validation
139
200
  # @param [Object] id Value to be assigned
140
201
  def id=(id)
@@ -161,6 +222,9 @@ module IncidentIo
161
222
  return true if self.equal?(o)
162
223
  self.class == o.class &&
163
224
  components == o.components &&
225
+ description == o.description &&
226
+ display_aggregated_uptime == o.display_aggregated_uptime &&
227
+ hidden == o.hidden &&
164
228
  id == o.id &&
165
229
  name == o.name
166
230
  end
@@ -174,7 +238,7 @@ module IncidentIo
174
238
  # Calculates hash code according to all attributes.
175
239
  # @return [Integer] Hash code
176
240
  def hash
177
- [components, id, name].hash
241
+ [components, description, display_aggregated_uptime, hidden, id, name].hash
178
242
  end
179
243
 
180
244
  # Builds the object from hash
@@ -17,10 +17,17 @@ module IncidentIo
17
17
  class StatusPagesShowStatusPageStructureResultV2 < ApiModelBase
18
18
  attr_accessor :current_structure
19
19
 
20
+ # How the page shows uptime against its components Known values: `chart_and_percentage`, `chart_only`, `nothing`
21
+ attr_accessor :display_uptime_mode
22
+
23
+ attr_accessor :management_meta
24
+
20
25
  # Attribute mapping from ruby-style variable name to JSON key.
21
26
  def self.attribute_map
22
27
  {
23
- :'current_structure' => :'current_structure'
28
+ :'current_structure' => :'current_structure',
29
+ :'display_uptime_mode' => :'display_uptime_mode',
30
+ :'management_meta' => :'management_meta'
24
31
  }
25
32
  end
26
33
 
@@ -37,7 +44,9 @@ module IncidentIo
37
44
  # Attribute type mapping.
38
45
  def self.openapi_types
39
46
  {
40
- :'current_structure' => :'StatusPageStructureV2'
47
+ :'current_structure' => :'StatusPageStructureV2',
48
+ :'display_uptime_mode' => :'String',
49
+ :'management_meta' => :'ManagementMetaV2'
41
50
  }
42
51
  end
43
52
 
@@ -68,6 +77,18 @@ module IncidentIo
68
77
  else
69
78
  self.current_structure = nil
70
79
  end
80
+
81
+ if attributes.key?(:'display_uptime_mode')
82
+ self.display_uptime_mode = attributes[:'display_uptime_mode']
83
+ else
84
+ self.display_uptime_mode = nil
85
+ end
86
+
87
+ if attributes.key?(:'management_meta')
88
+ self.management_meta = attributes[:'management_meta']
89
+ else
90
+ self.management_meta = nil
91
+ end
71
92
  end
72
93
 
73
94
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -79,6 +100,14 @@ module IncidentIo
79
100
  invalid_properties.push('invalid value for "current_structure", current_structure cannot be nil.')
80
101
  end
81
102
 
103
+ if @display_uptime_mode.nil?
104
+ invalid_properties.push('invalid value for "display_uptime_mode", display_uptime_mode cannot be nil.')
105
+ end
106
+
107
+ if @management_meta.nil?
108
+ invalid_properties.push('invalid value for "management_meta", management_meta cannot be nil.')
109
+ end
110
+
82
111
  invalid_properties
83
112
  end
84
113
 
@@ -87,6 +116,8 @@ module IncidentIo
87
116
  def valid?
88
117
  warn '[DEPRECATED] the `valid?` method is obsolete'
89
118
  return false if @current_structure.nil?
119
+ return false if @display_uptime_mode.nil?
120
+ return false if @management_meta.nil?
90
121
  true
91
122
  end
92
123
 
@@ -100,12 +131,34 @@ module IncidentIo
100
131
  @current_structure = current_structure
101
132
  end
102
133
 
134
+ # Custom attribute writer method with validation
135
+ # @param [Object] display_uptime_mode Value to be assigned
136
+ def display_uptime_mode=(display_uptime_mode)
137
+ if display_uptime_mode.nil?
138
+ fail ArgumentError, 'display_uptime_mode cannot be nil'
139
+ end
140
+
141
+ @display_uptime_mode = display_uptime_mode
142
+ end
143
+
144
+ # Custom attribute writer method with validation
145
+ # @param [Object] management_meta Value to be assigned
146
+ def management_meta=(management_meta)
147
+ if management_meta.nil?
148
+ fail ArgumentError, 'management_meta cannot be nil'
149
+ end
150
+
151
+ @management_meta = management_meta
152
+ end
153
+
103
154
  # Checks equality by comparing each attribute.
104
155
  # @param [Object] Object to be compared
105
156
  def ==(o)
106
157
  return true if self.equal?(o)
107
158
  self.class == o.class &&
108
- current_structure == o.current_structure
159
+ current_structure == o.current_structure &&
160
+ display_uptime_mode == o.display_uptime_mode &&
161
+ management_meta == o.management_meta
109
162
  end
110
163
 
111
164
  # @see the `==` method
@@ -117,7 +170,7 @@ module IncidentIo
117
170
  # Calculates hash code according to all attributes.
118
171
  # @return [Integer] Hash code
119
172
  def hash
120
- [current_structure].hash
173
+ [current_structure, display_uptime_mode, management_meta].hash
121
174
  end
122
175
 
123
176
  # Builds the object from hash
@@ -4,5 +4,5 @@ module IncidentIo
4
4
  # The release workflow sets this before building, so it tracks whatever we
5
5
  # last published. Listed in .openapi-generator-ignore so regeneration can't
6
6
  # reset it.
7
- VERSION = "2.6.0"
7
+ VERSION = "2.7.0"
8
8
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: incident_io_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.6.0
4
+ version: 2.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - incident.io
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-05 00:00:00.000000000 Z
11
+ date: 2026-10-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday