incident_io_api 2.43.0 → 2.45.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: a219468c782aebff19a2434c75cd84160c3903a0db4519298270c9a6425e4b77
4
- data.tar.gz: 5e8a43db3e2c38f45cdd08d8013412256196617a2026aac329e0cedf3b98825b
3
+ metadata.gz: 214f419dea8e377269456ee553f03b9828c075652638a1f6b75a62856520b2ac
4
+ data.tar.gz: a92ff012581e62b38de859b179460c7595f984bd51d2aa357085595887e5fa63
5
5
  SHA512:
6
- metadata.gz: f85bd58ab608c069e851774c31de26527494d8d97d82a1732d42befbc2ada5ed4e8aeba4d3f7b3fb394fc5b0c580533ada05dc6a371174cc6af0daa1d837ff6e
7
- data.tar.gz: d837393987e025db17cea40c7120f798d1aee4c65f169c26b4b6f3ed1bffb0ffc7cac398551c41fe517cc7b4891e79d9a40632a214bc0f1761ea6952a714a6a4
6
+ metadata.gz: 3670427b1b9fc792c4c7a7ddcadba9a414fdbd3d91edd18596386326559b0002973b3943507603a297a77de57d83569a85fbe5c1bd2dfd8f2db82bccddebcd0e
7
+ data.tar.gz: 3f89b6423a0dc56971acdc6fb282a248b37b521eca9eb272087e9a921179f4c71ba4141127879bf2c17c23f41445c036f11ceb0c297d75effc8eb715bba6f35e
@@ -825,6 +825,75 @@ module IncidentIo
825
825
  return data, status_code, headers
826
826
  end
827
827
 
828
+ # ShowStatusPageCustomerPage Status Pages V2
829
+ # Show one customer's page on a customer status page: its current status, its components, and the incidents and maintenance windows that customer sees. customer_id is the external_id of the catalog entry that defines the customer's page. That entry belongs to the catalog type the status page is split by. You can't use this endpoint for a customer whose catalog entry has no external_id. This endpoint requires a valid API key but no specific scopes. Responses can be up to 30 seconds old.
830
+ # @param status_page_id [String] ID of the customer status page. You can find this by calling the ListStatusPages endpoint.
831
+ # @param customer_id [String] The external_id of the customer's catalog entry
832
+ # @param [Hash] opts the optional parameters
833
+ # @return [StatusPagesShowStatusPageCustomerPageResultV2]
834
+ def status_pages_v2_show_status_page_customer_page(status_page_id, customer_id, opts = {})
835
+ data, _status_code, _headers = status_pages_v2_show_status_page_customer_page_with_http_info(status_page_id, customer_id, opts)
836
+ data
837
+ end
838
+
839
+ # ShowStatusPageCustomerPage Status Pages V2
840
+ # Show one customer's page on a customer status page: its current status, its components, and the incidents and maintenance windows that customer sees. customer_id is the external_id of the catalog entry that defines the customer's page. That entry belongs to the catalog type the status page is split by. You can't use this endpoint for a customer whose catalog entry has no external_id. This endpoint requires a valid API key but no specific scopes. Responses can be up to 30 seconds old.
841
+ # @param status_page_id [String] ID of the customer status page. You can find this by calling the ListStatusPages endpoint.
842
+ # @param customer_id [String] The external_id of the customer's catalog entry
843
+ # @param [Hash] opts the optional parameters
844
+ # @return [Array<(StatusPagesShowStatusPageCustomerPageResultV2, Integer, Hash)>] StatusPagesShowStatusPageCustomerPageResultV2 data, response status code and response headers
845
+ def status_pages_v2_show_status_page_customer_page_with_http_info(status_page_id, customer_id, opts = {})
846
+ if @api_client.config.debugging
847
+ @api_client.config.logger.debug 'Calling API: StatusPagesV2Api.status_pages_v2_show_status_page_customer_page ...'
848
+ end
849
+ # verify the required parameter 'status_page_id' is set
850
+ if @api_client.config.client_side_validation && status_page_id.nil?
851
+ fail ArgumentError, "Missing the required parameter 'status_page_id' when calling StatusPagesV2Api.status_pages_v2_show_status_page_customer_page"
852
+ end
853
+ # verify the required parameter 'customer_id' is set
854
+ if @api_client.config.client_side_validation && customer_id.nil?
855
+ fail ArgumentError, "Missing the required parameter 'customer_id' when calling StatusPagesV2Api.status_pages_v2_show_status_page_customer_page"
856
+ end
857
+ # resource path
858
+ local_var_path = '/v2/status_pages/{status_page_id}/customers/{customer_id}'.sub('{status_page_id}', CGI.escape(status_page_id.to_s)).sub('{customer_id}', CGI.escape(customer_id.to_s))
859
+
860
+ # query parameters
861
+ query_params = opts[:query_params] || {}
862
+
863
+ # header parameters
864
+ header_params = opts[:header_params] || {}
865
+ # HTTP header 'Accept' (if needed)
866
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
867
+
868
+ # form parameters
869
+ form_params = opts[:form_params] || {}
870
+
871
+ # http body (model)
872
+ post_body = opts[:debug_body]
873
+
874
+ # return_type
875
+ return_type = opts[:debug_return_type] || 'StatusPagesShowStatusPageCustomerPageResultV2'
876
+
877
+ # auth_names
878
+ auth_names = opts[:debug_auth_names] || ['BearerAuth']
879
+
880
+ new_options = opts.merge(
881
+ :operation => :"StatusPagesV2Api.status_pages_v2_show_status_page_customer_page",
882
+ :header_params => header_params,
883
+ :query_params => query_params,
884
+ :form_params => form_params,
885
+ :body => post_body,
886
+ :auth_names => auth_names,
887
+ :return_type => return_type
888
+ )
889
+
890
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
891
+ if @api_client.config.debugging
892
+ @api_client.config.logger.debug "API called: StatusPagesV2Api#status_pages_v2_show_status_page_customer_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
893
+ end
894
+ return data, status_code, headers
895
+ end
896
+
828
897
  # ShowStatusPageIncident Status Pages V2
829
898
  # Show a status page incident. This endpoint requires a valid API key but no specific scopes.
830
899
  # @param status_page_incident_id [String] ID of the status page incident
@@ -0,0 +1,165 @@
1
+ =begin
2
+ #incident.io
3
+
4
+ #Ruby client for the incident.io API.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.25.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module IncidentIo
17
+ class AuditLogTelemetryDataSourceAccessInheritanceChangedMetadataV2 < ApiModelBase
18
+ # Whether the data source takes its access mode and teams from its parent after the change (true, false)
19
+ attr_accessor :inherits_access
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'inherits_access' => :'inherits_access'
25
+ }
26
+ end
27
+
28
+ # Returns attribute mapping this model knows about
29
+ def self.acceptable_attribute_map
30
+ attribute_map
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ acceptable_attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'inherits_access' => :'String'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `IncidentIo::AuditLogTelemetryDataSourceAccessInheritanceChangedMetadataV2` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ acceptable_attribute_map = self.class.acceptable_attribute_map
60
+ attributes = attributes.each_with_object({}) { |(k, v), h|
61
+ if (!acceptable_attribute_map.key?(k.to_sym))
62
+ fail ArgumentError, "`#{k}` is not a valid attribute in `IncidentIo::AuditLogTelemetryDataSourceAccessInheritanceChangedMetadataV2`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
63
+ end
64
+ h[k.to_sym] = v
65
+ }
66
+
67
+ if attributes.key?(:'inherits_access')
68
+ self.inherits_access = attributes[:'inherits_access']
69
+ else
70
+ self.inherits_access = nil
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
78
+ invalid_properties = Array.new
79
+ if @inherits_access.nil?
80
+ invalid_properties.push('invalid value for "inherits_access", inherits_access cannot be nil.')
81
+ end
82
+
83
+ invalid_properties
84
+ end
85
+
86
+ # Check to see if the all the properties in the model are valid
87
+ # @return true if the model is valid
88
+ def valid?
89
+ warn '[DEPRECATED] the `valid?` method is obsolete'
90
+ return false if @inherits_access.nil?
91
+ true
92
+ end
93
+
94
+ # Custom attribute writer method with validation
95
+ # @param [Object] inherits_access Value to be assigned
96
+ def inherits_access=(inherits_access)
97
+ if inherits_access.nil?
98
+ fail ArgumentError, 'inherits_access cannot be nil'
99
+ end
100
+
101
+ @inherits_access = inherits_access
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ inherits_access == o.inherits_access
110
+ end
111
+
112
+ # @see the `==` method
113
+ # @param [Object] Object to be compared
114
+ def eql?(o)
115
+ self == o
116
+ end
117
+
118
+ # Calculates hash code according to all attributes.
119
+ # @return [Integer] Hash code
120
+ def hash
121
+ [inherits_access].hash
122
+ end
123
+
124
+ # Builds the object from hash
125
+ # @param [Hash] attributes Model attributes in the form of hash
126
+ # @return [Object] Returns the model itself
127
+ def self.build_from_hash(attributes)
128
+ return nil unless attributes.is_a?(Hash)
129
+ attributes = attributes.transform_keys(&:to_sym)
130
+ transformed_hash = {}
131
+ openapi_types.each_pair do |key, type|
132
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = nil
134
+ elsif type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[attribute_map[key]].is_a?(Array)
138
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
139
+ end
140
+ elsif !attributes[attribute_map[key]].nil?
141
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
142
+ end
143
+ end
144
+ new(transformed_hash)
145
+ end
146
+
147
+ # Returns the object in the form of hash
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_hash
150
+ hash = {}
151
+ self.class.attribute_map.each_pair do |attr, param|
152
+ value = self.send(attr)
153
+ if value.nil?
154
+ is_nullable = self.class.openapi_nullable.include?(attr)
155
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
156
+ end
157
+
158
+ hash[param] = _to_hash(value)
159
+ end
160
+ hash
161
+ end
162
+
163
+ end
164
+
165
+ end
@@ -0,0 +1,326 @@
1
+ =begin
2
+ #incident.io
3
+
4
+ #Ruby client for the incident.io API.
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.25.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module IncidentIo
17
+ class AuditLogsTelemetryDataSourceAccessInheritanceChangedV1 < ApiModelBase
18
+ # The type of log entry that this is
19
+ attr_accessor :action
20
+
21
+ attr_accessor :actor
22
+
23
+ attr_accessor :context
24
+
25
+ attr_accessor :metadata
26
+
27
+ # When the entry occurred
28
+ attr_accessor :occurred_at
29
+
30
+ # The custom field that was created
31
+ attr_accessor :targets
32
+
33
+ # Which version the event is
34
+ attr_accessor :version
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'action' => :'action',
40
+ :'actor' => :'actor',
41
+ :'context' => :'context',
42
+ :'metadata' => :'metadata',
43
+ :'occurred_at' => :'occurred_at',
44
+ :'targets' => :'targets',
45
+ :'version' => :'version'
46
+ }
47
+ end
48
+
49
+ # Returns attribute mapping this model knows about
50
+ def self.acceptable_attribute_map
51
+ attribute_map
52
+ end
53
+
54
+ # Returns all the JSON keys this model knows about
55
+ def self.acceptable_attributes
56
+ acceptable_attribute_map.values
57
+ end
58
+
59
+ # Attribute type mapping.
60
+ def self.openapi_types
61
+ {
62
+ :'action' => :'String',
63
+ :'actor' => :'AuditLogActorV2',
64
+ :'context' => :'AuditLogEntryContextV2',
65
+ :'metadata' => :'AuditLogTelemetryDataSourceAccessInheritanceChangedMetadataV2',
66
+ :'occurred_at' => :'Time',
67
+ :'targets' => :'Array<AuditLogTargetV2>',
68
+ :'version' => :'Integer'
69
+ }
70
+ end
71
+
72
+ # List of attributes with nullable: true
73
+ def self.openapi_nullable
74
+ Set.new([
75
+ ])
76
+ end
77
+
78
+ # Initializes the object
79
+ # @param [Hash] attributes Model attributes in the form of hash
80
+ def initialize(attributes = {})
81
+ if (!attributes.is_a?(Hash))
82
+ fail ArgumentError, "The input argument (attributes) must be a hash in `IncidentIo::AuditLogsTelemetryDataSourceAccessInheritanceChangedV1` initialize method"
83
+ end
84
+
85
+ # check to see if the attribute exists and convert string to symbol for hash key
86
+ acceptable_attribute_map = self.class.acceptable_attribute_map
87
+ attributes = attributes.each_with_object({}) { |(k, v), h|
88
+ if (!acceptable_attribute_map.key?(k.to_sym))
89
+ fail ArgumentError, "`#{k}` is not a valid attribute in `IncidentIo::AuditLogsTelemetryDataSourceAccessInheritanceChangedV1`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
90
+ end
91
+ h[k.to_sym] = v
92
+ }
93
+
94
+ if attributes.key?(:'action')
95
+ self.action = attributes[:'action']
96
+ else
97
+ self.action = nil
98
+ end
99
+
100
+ if attributes.key?(:'actor')
101
+ self.actor = attributes[:'actor']
102
+ else
103
+ self.actor = nil
104
+ end
105
+
106
+ if attributes.key?(:'context')
107
+ self.context = attributes[:'context']
108
+ else
109
+ self.context = nil
110
+ end
111
+
112
+ if attributes.key?(:'metadata')
113
+ self.metadata = attributes[:'metadata']
114
+ else
115
+ self.metadata = nil
116
+ end
117
+
118
+ if attributes.key?(:'occurred_at')
119
+ self.occurred_at = attributes[:'occurred_at']
120
+ else
121
+ self.occurred_at = nil
122
+ end
123
+
124
+ if attributes.key?(:'targets')
125
+ if (value = attributes[:'targets']).is_a?(Array)
126
+ self.targets = value
127
+ end
128
+ else
129
+ self.targets = nil
130
+ end
131
+
132
+ if attributes.key?(:'version')
133
+ self.version = attributes[:'version']
134
+ else
135
+ self.version = nil
136
+ end
137
+ end
138
+
139
+ # Show invalid properties with the reasons. Usually used together with valid?
140
+ # @return Array for valid properties with the reasons
141
+ def list_invalid_properties
142
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
143
+ invalid_properties = Array.new
144
+ if @action.nil?
145
+ invalid_properties.push('invalid value for "action", action cannot be nil.')
146
+ end
147
+
148
+ if @actor.nil?
149
+ invalid_properties.push('invalid value for "actor", actor cannot be nil.')
150
+ end
151
+
152
+ if @context.nil?
153
+ invalid_properties.push('invalid value for "context", context cannot be nil.')
154
+ end
155
+
156
+ if @metadata.nil?
157
+ invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
158
+ end
159
+
160
+ if @occurred_at.nil?
161
+ invalid_properties.push('invalid value for "occurred_at", occurred_at cannot be nil.')
162
+ end
163
+
164
+ if @targets.nil?
165
+ invalid_properties.push('invalid value for "targets", targets cannot be nil.')
166
+ end
167
+
168
+ if @version.nil?
169
+ invalid_properties.push('invalid value for "version", version cannot be nil.')
170
+ end
171
+
172
+ invalid_properties
173
+ end
174
+
175
+ # Check to see if the all the properties in the model are valid
176
+ # @return true if the model is valid
177
+ def valid?
178
+ warn '[DEPRECATED] the `valid?` method is obsolete'
179
+ return false if @action.nil?
180
+ return false if @actor.nil?
181
+ return false if @context.nil?
182
+ return false if @metadata.nil?
183
+ return false if @occurred_at.nil?
184
+ return false if @targets.nil?
185
+ return false if @version.nil?
186
+ true
187
+ end
188
+
189
+ # Custom attribute writer method with validation
190
+ # @param [Object] action Value to be assigned
191
+ def action=(action)
192
+ if action.nil?
193
+ fail ArgumentError, 'action cannot be nil'
194
+ end
195
+
196
+ @action = action
197
+ end
198
+
199
+ # Custom attribute writer method with validation
200
+ # @param [Object] actor Value to be assigned
201
+ def actor=(actor)
202
+ if actor.nil?
203
+ fail ArgumentError, 'actor cannot be nil'
204
+ end
205
+
206
+ @actor = actor
207
+ end
208
+
209
+ # Custom attribute writer method with validation
210
+ # @param [Object] context Value to be assigned
211
+ def context=(context)
212
+ if context.nil?
213
+ fail ArgumentError, 'context cannot be nil'
214
+ end
215
+
216
+ @context = context
217
+ end
218
+
219
+ # Custom attribute writer method with validation
220
+ # @param [Object] metadata Value to be assigned
221
+ def metadata=(metadata)
222
+ if metadata.nil?
223
+ fail ArgumentError, 'metadata cannot be nil'
224
+ end
225
+
226
+ @metadata = metadata
227
+ end
228
+
229
+ # Custom attribute writer method with validation
230
+ # @param [Object] occurred_at Value to be assigned
231
+ def occurred_at=(occurred_at)
232
+ if occurred_at.nil?
233
+ fail ArgumentError, 'occurred_at cannot be nil'
234
+ end
235
+
236
+ @occurred_at = occurred_at
237
+ end
238
+
239
+ # Custom attribute writer method with validation
240
+ # @param [Object] targets Value to be assigned
241
+ def targets=(targets)
242
+ if targets.nil?
243
+ fail ArgumentError, 'targets cannot be nil'
244
+ end
245
+
246
+ @targets = targets
247
+ end
248
+
249
+ # Custom attribute writer method with validation
250
+ # @param [Object] version Value to be assigned
251
+ def version=(version)
252
+ if version.nil?
253
+ fail ArgumentError, 'version cannot be nil'
254
+ end
255
+
256
+ @version = version
257
+ end
258
+
259
+ # Checks equality by comparing each attribute.
260
+ # @param [Object] Object to be compared
261
+ def ==(o)
262
+ return true if self.equal?(o)
263
+ self.class == o.class &&
264
+ action == o.action &&
265
+ actor == o.actor &&
266
+ context == o.context &&
267
+ metadata == o.metadata &&
268
+ occurred_at == o.occurred_at &&
269
+ targets == o.targets &&
270
+ version == o.version
271
+ end
272
+
273
+ # @see the `==` method
274
+ # @param [Object] Object to be compared
275
+ def eql?(o)
276
+ self == o
277
+ end
278
+
279
+ # Calculates hash code according to all attributes.
280
+ # @return [Integer] Hash code
281
+ def hash
282
+ [action, actor, context, metadata, occurred_at, targets, version].hash
283
+ end
284
+
285
+ # Builds the object from hash
286
+ # @param [Hash] attributes Model attributes in the form of hash
287
+ # @return [Object] Returns the model itself
288
+ def self.build_from_hash(attributes)
289
+ return nil unless attributes.is_a?(Hash)
290
+ attributes = attributes.transform_keys(&:to_sym)
291
+ transformed_hash = {}
292
+ openapi_types.each_pair do |key, type|
293
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
294
+ transformed_hash["#{key}"] = nil
295
+ elsif type =~ /\AArray<(.*)>/i
296
+ # check to ensure the input is an array given that the attribute
297
+ # is documented as an array but the input is not
298
+ if attributes[attribute_map[key]].is_a?(Array)
299
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
300
+ end
301
+ elsif !attributes[attribute_map[key]].nil?
302
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
303
+ end
304
+ end
305
+ new(transformed_hash)
306
+ end
307
+
308
+ # Returns the object in the form of hash
309
+ # @return [Hash] Returns the object in the form of hash
310
+ def to_hash
311
+ hash = {}
312
+ self.class.attribute_map.each_pair do |attr, param|
313
+ value = self.send(attr)
314
+ if value.nil?
315
+ is_nullable = self.class.openapi_nullable.include?(attr)
316
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
317
+ end
318
+
319
+ hash[param] = _to_hash(value)
320
+ end
321
+ hash
322
+ end
323
+
324
+ end
325
+
326
+ end