smplkit 3.0.65 → 3.0.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16abf7a226f27e82a2343a6a85e23ee92f2f15198bd5353f94ee8daa51af36d3
-  data.tar.gz: f43cc4fb669ff5ce6cd3fb81e84bdc64f5b619be2df2c1b2328ad1f62c4bd512
+  metadata.gz: d5625133c3c3fc48e8d783211e3ccfee90572775dbad53141ea6f809e8e79f0d
+  data.tar.gz: c06c855003e82bfd116fcdec13430b64d199ef00a81e84b6b176d2bda42e104c
 SHA512:
-  metadata.gz: a2fbbc5b9369e51bb2729ca286a19a40ef1c40af66c803f28a8b7baa7d7d218128906b75a254fc7126c4dd3ce6f4127cf558e1554f261a978641906cd2451421
-  data.tar.gz: cea0ae0643d5be5e403e0c398543933a1cdcd9e1d68fb77a02004c3021e657585d4861eb6aded5740e75531bf8a0d31c981ad63eca64b0e91bb5337f7ba1096f
+  metadata.gz: e3483d8514c812a512d857eef02a591eb023e65c38c4408ffbbeba6be650ce9c058c42b6421934bdb37eb6a40730cc5a2659c5e042067edc54c604691601595f
+  data.tar.gz: 065be639582028946d863d675b4000c49c34a96e377a15d4b23a484eb05bd95f812cc4815258c788fd68e233e71d8abe834655e70c8e575b9fb96c5cee5cbe73

data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/group_memberships_api.rb

@@ -0,0 +1,295 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module SmplkitGeneratedClient::App
+  class GroupMembershipsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Group Membership
+    # Add a user to a group. The body references the user (UUID) and the group (key) in the resource attributes. Returns `409` if this user is already a member of this group, or `422` if either the user is not a member of the account or the group does not exist.
+    # @param group_membership_request [GroupMembershipRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GroupMembershipResponse]
+    def create_group_membership(group_membership_request, opts = {})
+      data, _status_code, _headers = create_group_membership_with_http_info(group_membership_request, opts)
+      data
+    end
+
+    # Create Group Membership
+    # Add a user to a group. The body references the user (UUID) and the group (key) in the resource attributes. Returns `409` if this user is already a member of this group, or `422` if either the user is not a member of the account or the group does not exist.
+    # @param group_membership_request [GroupMembershipRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupMembershipResponse, Integer, Hash)>] GroupMembershipResponse data, response status code and response headers
+    def create_group_membership_with_http_info(group_membership_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.create_group_membership ...'
+      end
+      # verify the required parameter 'group_membership_request' is set
+      if @api_client.config.client_side_validation && group_membership_request.nil?
+        fail ArgumentError, "Missing the required parameter 'group_membership_request' when calling GroupMembershipsApi.create_group_membership"
+      end
+      # resource path
+      local_var_path = '/api/v1/group_memberships'
+
+      # 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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+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(group_membership_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GroupMembershipResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupMembershipsApi.create_group_membership",
+        :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: GroupMembershipsApi#create_group_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Group Membership
+    # Remove a user from a group. Returns `409` when the membership is the user's `default` membership — every user must remain in the `default` group per ADR-055 §4.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_group_membership(id, opts = {})
+      delete_group_membership_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Group Membership
+    # Remove a user from a group. Returns &#x60;409&#x60; when the membership is the user&#39;s &#x60;default&#x60; membership — every user must remain in the &#x60;default&#x60; group per ADR-055 §4.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_group_membership_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.delete_group_membership ...'
+      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 GroupMembershipsApi.delete_group_membership"
+      end
+      # resource path
+      local_var_path = '/api/v1/group_memberships/{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/vnd.api+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] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupMembershipsApi.delete_group_membership",
+        :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: GroupMembershipsApi#delete_group_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Group Membership
+    # Return a single membership by id.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GroupMembershipResponse]
+    def get_group_membership(id, opts = {})
+      data, _status_code, _headers = get_group_membership_with_http_info(id, opts)
+      data
+    end
+
+    # Get Group Membership
+    # Return a single membership by id.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupMembershipResponse, Integer, Hash)>] GroupMembershipResponse data, response status code and response headers
+    def get_group_membership_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.get_group_membership ...'
+      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 GroupMembershipsApi.get_group_membership"
+      end
+      # resource path
+      local_var_path = '/api/v1/group_memberships/{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/vnd.api+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] || 'GroupMembershipResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupMembershipsApi.get_group_membership",
+        :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: GroupMembershipsApi#get_group_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Group Memberships
+    # List group memberships in the authenticated account. Pass `filter[group]` (a group key) to list members of a single group, or `filter[user]` (a UUID) to list a single user's memberships. The two filters may be combined to look up a specific (user, group) pair.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_group Group key to narrow the result to memberships in that group.
+    # @option opts [String] :filter_user User UUID to narrow the result to memberships for that user.
+    # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'created_at')
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [GroupMembershipListResponse]
+    def list_group_memberships(opts = {})
+      data, _status_code, _headers = list_group_memberships_with_http_info(opts)
+      data
+    end
+
+    # List Group Memberships
+    # List group memberships in the authenticated account. Pass &#x60;filter[group]&#x60; (a group key) to list members of a single group, or &#x60;filter[user]&#x60; (a UUID) to list a single user&#39;s memberships. The two filters may be combined to look up a specific (user, group) pair.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_group Group key to narrow the result to memberships in that group.
+    # @option opts [String] :filter_user User UUID to narrow the result to memberships for that user.
+    # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'created_at')
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [Array<(GroupMembershipListResponse, Integer, Hash)>] GroupMembershipListResponse data, response status code and response headers
+    def list_group_memberships_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupMembershipsApi.list_group_memberships ...'
+      end
+      allowable_values = ["created_at", "-created_at", "updated_at", "-updated_at"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v1/group_memberships'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[group]'] = opts[:'filter_group'] if !opts[:'filter_group'].nil?
+      query_params[:'filter[user]'] = opts[:'filter_user'] if !opts[:'filter_user'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'GroupMembershipListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupMembershipsApi.list_group_memberships",
+        :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: GroupMembershipsApi#list_group_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/groups_api.rb

@@ -0,0 +1,366 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module SmplkitGeneratedClient::App
+  class GroupsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Group
+    # Create an Environment Access Group. The caller provides the group id (a snake-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
+    # @param group_create_request [GroupCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GroupResponse]
+    def create_group(group_create_request, opts = {})
+      data, _status_code, _headers = create_group_with_http_info(group_create_request, opts)
+      data
+    end
+
+    # Create Group
+    # Create an Environment Access Group. The caller provides the group id (a snake-case key, unique within the account) in the request body. The id is immutable thereafter. Returns `409` if a group with that id already exists, or `422` if `managed_environments` is not exactly `['*']` or a subset of the account's standard environment keys.
+    # @param group_create_request [GroupCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupResponse, Integer, Hash)>] GroupResponse data, response status code and response headers
+    def create_group_with_http_info(group_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.create_group ...'
+      end
+      # verify the required parameter 'group_create_request' is set
+      if @api_client.config.client_side_validation && group_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'group_create_request' when calling GroupsApi.create_group"
+      end
+      # resource path
+      local_var_path = '/api/v1/groups'
+
+      # 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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+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(group_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GroupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupsApi.create_group",
+        :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: GroupsApi#create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Group
+    # Delete a group by id. Returns `409` for the reserved `default` group, which every account requires. Deleting a group also cascades to its memberships.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_group(id, opts = {})
+      delete_group_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Group
+    # Delete a group by id. Returns &#x60;409&#x60; for the reserved &#x60;default&#x60; group, which every account requires. Deleting a group also cascades to its memberships.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_group_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.delete_group ...'
+      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 GroupsApi.delete_group"
+      end
+      # resource path
+      local_var_path = '/api/v1/groups/{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/vnd.api+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] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupsApi.delete_group",
+        :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: GroupsApi#delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Group
+    # Return a group by id.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GroupResponse]
+    def get_group(id, opts = {})
+      data, _status_code, _headers = get_group_with_http_info(id, opts)
+      data
+    end
+
+    # Get Group
+    # Return a group by id.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupResponse, Integer, Hash)>] GroupResponse data, response status code and response headers
+    def get_group_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.get_group ...'
+      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 GroupsApi.get_group"
+      end
+      # resource path
+      local_var_path = '/api/v1/groups/{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/vnd.api+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] || 'GroupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupsApi.get_group",
+        :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: GroupsApi#get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Groups
+    # List Environment Access Groups for the authenticated account. `filter[search]` does a case-insensitive substring match against the group `key` and `name`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_search Case-insensitive substring match against the group &#x60;key&#x60; and &#x60;name&#x60;. A group is returned if either field contains the search term.
+    # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;key&#x60;, &#x60;-key&#x60;, &#x60;name&#x60;, &#x60;-name&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'name')
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [GroupListResponse]
+    def list_groups(opts = {})
+      data, _status_code, _headers = list_groups_with_http_info(opts)
+      data
+    end
+
+    # List Groups
+    # List Environment Access Groups for the authenticated account. &#x60;filter[search]&#x60; does a case-insensitive substring match against the group &#x60;key&#x60; and &#x60;name&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_search Case-insensitive substring match against the group &#x60;key&#x60; and &#x60;name&#x60;. A group is returned if either field contains the search term.
+    # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;key&#x60;, &#x60;-key&#x60;, &#x60;name&#x60;, &#x60;-name&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'name')
+    # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
+    # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
+    # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
+    # @return [Array<(GroupListResponse, Integer, Hash)>] GroupListResponse data, response status code and response headers
+    def list_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.list_groups ...'
+      end
+      allowable_values = ["created_at", "-created_at", "key", "-key", "name", "-name", "updated_at", "-updated_at"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v1/groups'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[search]'] = opts[:'filter_search'] if !opts[:'filter_search'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'GroupListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupsApi.list_groups",
+        :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: GroupsApi#list_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Group
+    # Update a group's name, description, and managed environments. Whole-resource semantics — submit every writable attribute. For the reserved `default` group, `managed_environments` may be changed (this is the lever that narrows the account-wide baseline), but renaming or other identity changes are rejected with `409`. Invalid `managed_environments` is `422`.
+    # @param id [String] 
+    # @param group_request [GroupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GroupResponse]
+    def update_group(id, group_request, opts = {})
+      data, _status_code, _headers = update_group_with_http_info(id, group_request, opts)
+      data
+    end
+
+    # Update Group
+    # Update a group&#39;s name, description, and managed environments. Whole-resource semantics — submit every writable attribute. For the reserved &#x60;default&#x60; group, &#x60;managed_environments&#x60; may be changed (this is the lever that narrows the account-wide baseline), but renaming or other identity changes are rejected with &#x60;409&#x60;. Invalid &#x60;managed_environments&#x60; is &#x60;422&#x60;.
+    # @param id [String] 
+    # @param group_request [GroupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GroupResponse, Integer, Hash)>] GroupResponse data, response status code and response headers
+    def update_group_with_http_info(id, group_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.update_group ...'
+      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 GroupsApi.update_group"
+      end
+      # verify the required parameter 'group_request' is set
+      if @api_client.config.client_side_validation && group_request.nil?
+        fail ArgumentError, "Missing the required parameter 'group_request' when calling GroupsApi.update_group"
+      end
+      # resource path
+      local_var_path = '/api/v1/groups/{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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+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(group_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GroupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"GroupsApi.update_group",
+        :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: GroupsApi#update_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end