incident_io_api 2.22.0 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c17f2227b4d29663755fb7e211d871e0b7641a5ec4747c2f679db8fbf83f9a0
-  data.tar.gz: 1a91bb901241bcc337d0f7c0896de115171c9feb7a7648b8017062d9c9d6e6d5
+  metadata.gz: 5f86ae894fe065c7d6f3326280a8b37b10f8688972307d2fe094ae3d36199a2b
+  data.tar.gz: 10664d9e60096b37614941758d788478ea00319cb80941b6aa5eb395be7c7ddd
 SHA512:
-  metadata.gz: 8f78bc27dd6a66d618902d2e38dcb2bc1008b17394f7da78106898076984abb6f84e5c0e1ed7ca6d31f2675ac53ba6b66fe8f40b7829c988c87f517910604091
-  data.tar.gz: 30fdd4e5135712f5e52c50bbff7454b24f5b51f4cf8ba00f92520ad565764f74a953c8fb1e8e3a9d1c820d4d52478dcd32f10f071243ca62a7ac01671f25e46d
+  metadata.gz: a28e72e1f83e16118a162494f9820ec5a46bb55a9b5c05b8d3ef06d8a1861139e0987c99499b18e3c61e56009d9bf1a31cebf53ba6a260a058d96a3af37572c1
+  data.tar.gz: 1ac1c1771181c620883bf475af82a6e045f4fd67fa30d175ba654110a2bc3fb97e2970809b23cc38f7f3f595e45e8a2883dd8cb69772b1b0027e65e5724ddbe2

data/lib/incident_io/api/glossary_entries_v2_api.rb

@@ -0,0 +1,432 @@
+=begin
+#incident.io
+
+#Ruby client for the incident.io API.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module IncidentIo
+  class GlossaryEntriesV2Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Glossary Entries V2
+    # Create a glossary entry. It is appended to the end of the glossary unless after names an existing entry to insert it after.
+    # @param glossary_entries_create_payload_v2 [GlossaryEntriesCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [GlossaryEntriesCreateResultV2]
+    def glossary_entries_v2_create(glossary_entries_create_payload_v2, opts = {})
+      data, _status_code, _headers = glossary_entries_v2_create_with_http_info(glossary_entries_create_payload_v2, opts)
+      data
+    end
+
+    # Create Glossary Entries V2
+    # Create a glossary entry. It is appended to the end of the glossary unless after names an existing entry to insert it after.
+    # @param glossary_entries_create_payload_v2 [GlossaryEntriesCreatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GlossaryEntriesCreateResultV2, Integer, Hash)>] GlossaryEntriesCreateResultV2 data, response status code and response headers
+    def glossary_entries_v2_create_with_http_info(glossary_entries_create_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_create ...'
+      end
+      # verify the required parameter 'glossary_entries_create_payload_v2' is set
+      if @api_client.config.client_side_validation && glossary_entries_create_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'glossary_entries_create_payload_v2' when calling GlossaryEntriesV2Api.glossary_entries_v2_create"
+      end
+      # resource path
+      local_var_path = '/v2/glossary_entries'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(glossary_entries_create_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlossaryEntriesCreateResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Destroy Glossary Entries V2
+    # Delete a glossary entry. The entry is archived, which frees its term so the same item can be added again later.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def glossary_entries_v2_destroy(id, opts = {})
+      glossary_entries_v2_destroy_with_http_info(id, opts)
+      nil
+    end
+
+    # Destroy Glossary Entries V2
+    # Delete a glossary entry. The entry is archived, which frees its term so the same item can be added again later.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def glossary_entries_v2_destroy_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_destroy ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryEntriesV2Api.glossary_entries_v2_destroy"
+      end
+      # resource path
+      local_var_path = '/v2/glossary_entries/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_destroy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Glossary Entries V2
+    # List glossary entries for this organisation, in rank order.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Number of glossary entries to return per page (default to 25)
+    # @option opts [String] :after A glossary entry&#39;s ID. This endpoint returns entries after this one. Without search, that is later in rank order. With search, it is the next hit after this entry.
+    # @option opts [String] :search Filter to entries whose term or description contains this value (case-insensitive)
+    # @return [GlossaryEntriesListResultV2]
+    def glossary_entries_v2_list(opts = {})
+      data, _status_code, _headers = glossary_entries_v2_list_with_http_info(opts)
+      data
+    end
+
+    # List Glossary Entries V2
+    # List glossary entries for this organisation, in rank order.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Number of glossary entries to return per page (default to 25)
+    # @option opts [String] :after A glossary entry&#39;s ID. This endpoint returns entries after this one. Without search, that is later in rank order. With search, it is the next hit after this entry.
+    # @option opts [String] :search Filter to entries whose term or description contains this value (case-insensitive)
+    # @return [Array<(GlossaryEntriesListResultV2, Integer, Hash)>] GlossaryEntriesListResultV2 data, response status code and response headers
+    def glossary_entries_v2_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling GlossaryEntriesV2Api.glossary_entries_v2_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling GlossaryEntriesV2Api.glossary_entries_v2_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v2/glossary_entries'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlossaryEntriesListResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Show Glossary Entries V2
+    # Get a single glossary entry.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param [Hash] opts the optional parameters
+    # @return [GlossaryEntriesShowResultV2]
+    def glossary_entries_v2_show(id, opts = {})
+      data, _status_code, _headers = glossary_entries_v2_show_with_http_info(id, opts)
+      data
+    end
+
+    # Show Glossary Entries V2
+    # Get a single glossary entry.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GlossaryEntriesShowResultV2, Integer, Hash)>] GlossaryEntriesShowResultV2 data, response status code and response headers
+    def glossary_entries_v2_show_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_show ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryEntriesV2Api.glossary_entries_v2_show"
+      end
+      # resource path
+      local_var_path = '/v2/glossary_entries/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlossaryEntriesShowResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_show",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Glossary Entries V2
+    # Update a glossary entry's term or description. Rank is unchanged; use the reorder action for that.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param glossary_entries_update_payload_v2 [GlossaryEntriesUpdatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [GlossaryEntriesUpdateResultV2]
+    def glossary_entries_v2_update(id, glossary_entries_update_payload_v2, opts = {})
+      data, _status_code, _headers = glossary_entries_v2_update_with_http_info(id, glossary_entries_update_payload_v2, opts)
+      data
+    end
+
+    # Update Glossary Entries V2
+    # Update a glossary entry&#39;s term or description. Rank is unchanged; use the reorder action for that.
+    # @param id [String] Unique identifier for this glossary entry
+    # @param glossary_entries_update_payload_v2 [GlossaryEntriesUpdatePayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GlossaryEntriesUpdateResultV2, Integer, Hash)>] GlossaryEntriesUpdateResultV2 data, response status code and response headers
+    def glossary_entries_v2_update_with_http_info(id, glossary_entries_update_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryEntriesV2Api.glossary_entries_v2_update"
+      end
+      # verify the required parameter 'glossary_entries_update_payload_v2' is set
+      if @api_client.config.client_side_validation && glossary_entries_update_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'glossary_entries_update_payload_v2' when calling GlossaryEntriesV2Api.glossary_entries_v2_update"
+      end
+      # resource path
+      local_var_path = '/v2/glossary_entries/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(glossary_entries_update_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlossaryEntriesUpdateResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # UpdateRanks Glossary Entries V2
+    # Reorder glossary entries. Every live entry must be included exactly once.
+    # @param glossary_entries_update_ranks_payload_v2 [GlossaryEntriesUpdateRanksPayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [GlossaryEntriesUpdateRanksResultV2]
+    def glossary_entries_v2_update_ranks(glossary_entries_update_ranks_payload_v2, opts = {})
+      data, _status_code, _headers = glossary_entries_v2_update_ranks_with_http_info(glossary_entries_update_ranks_payload_v2, opts)
+      data
+    end
+
+    # UpdateRanks Glossary Entries V2
+    # Reorder glossary entries. Every live entry must be included exactly once.
+    # @param glossary_entries_update_ranks_payload_v2 [GlossaryEntriesUpdateRanksPayloadV2] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GlossaryEntriesUpdateRanksResultV2, Integer, Hash)>] GlossaryEntriesUpdateRanksResultV2 data, response status code and response headers
+    def glossary_entries_v2_update_ranks_with_http_info(glossary_entries_update_ranks_payload_v2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlossaryEntriesV2Api.glossary_entries_v2_update_ranks ...'
+      end
+      # verify the required parameter 'glossary_entries_update_ranks_payload_v2' is set
+      if @api_client.config.client_side_validation && glossary_entries_update_ranks_payload_v2.nil?
+        fail ArgumentError, "Missing the required parameter 'glossary_entries_update_ranks_payload_v2' when calling GlossaryEntriesV2Api.glossary_entries_v2_update_ranks"
+      end
+      # resource path
+      local_var_path = '/v2/glossary_entries/actions/update_ranks'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(glossary_entries_update_ranks_payload_v2)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GlossaryEntriesUpdateRanksResultV2'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"GlossaryEntriesV2Api.glossary_entries_v2_update_ranks",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlossaryEntriesV2Api#glossary_entries_v2_update_ranks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/incident_io/api/incidents_v2_api.rb

@@ -20,7 +20,7 @@ module IncidentIo
       @api_client = api_client
     end
     # ConnectExternalIssue Incidents V2
-    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
+    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This works whether or not automatic incident ticket creation is turned on. While it is off, no tickets are created for other incidents, and the incident's fields are not written into this issue until it is turned on.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
     # @param id [String] The unique identifier of the incident
     # @param incidents_connect_external_issue_payload_v2 [IncidentsConnectExternalIssuePayloadV2] 
     # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module IncidentIo
     end
 
     # ConnectExternalIssue Incidents V2
-    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
+    # Connect an existing issue in an issue tracker to an incident, as its external issue.  The issue is synced using the given incident ticket template, as if incident.io had created it from that template. The next sync writes the incident's fields into the issue.  This works whether or not automatic incident ticket creation is turned on. While it is off, no tickets are created for other incidents, and the incident's fields are not written into this issue until it is turned on.  This needs the incidents.connect_external_issue scope, either across the organisation or from an incident role on this incident.  This fails if the incident already has a different external issue (unless replace is true), or if the issue is already linked to another incident or follow-up.  The ID supplied can be either the incident's full ID, or the numeric part of its reference.
     # @param id [String] The unique identifier of the incident
     # @param incidents_connect_external_issue_payload_v2 [IncidentsConnectExternalIssuePayloadV2] 
     # @param [Hash] opts the optional parameters

data/lib/incident_io/models/glossary_entries_create_payload_v2.rb

@@ -0,0 +1,220 @@
+=begin
+#incident.io
+
+#Ruby client for the incident.io API.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module IncidentIo
+  class GlossaryEntriesCreatePayloadV2 < ApiModelBase
+    # ID of a live glossary entry. The new entry is inserted immediately after it. Omit to append the entry to the end.
+    attr_accessor :after
+
+    # What the term means
+    attr_accessor :description
+
+    # The term, for example an acronym or service name. Unique among live entries, ignoring case.
+    attr_accessor :item
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'after' => :'after',
+        :'description' => :'description',
+        :'item' => :'item'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'after' => :'String',
+        :'description' => :'String',
+        :'item' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `IncidentIo::GlossaryEntriesCreatePayloadV2` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `IncidentIo::GlossaryEntriesCreatePayloadV2`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'after')
+        self.after = attributes[:'after']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'item')
+        self.item = attributes[:'item']
+      else
+        self.item = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
+      end
+
+      if @item.nil?
+        invalid_properties.push('invalid value for "item", item cannot be nil.')
+      end
+
+      if @item.to_s.length > 128
+        invalid_properties.push('invalid value for "item", the character length must be smaller than or equal to 128.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @description.nil?
+      return false if @description.to_s.length > 2000
+      return false if @item.nil?
+      return false if @item.to_s.length > 128
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] item Value to be assigned
+    def item=(item)
+      if item.nil?
+        fail ArgumentError, 'item cannot be nil'
+      end
+
+      if item.to_s.length > 128
+        fail ArgumentError, 'invalid value for "item", the character length must be smaller than or equal to 128.'
+      end
+
+      @item = item
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          after == o.after &&
+          description == o.description &&
+          item == o.item
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [after, description, item].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end