lockally 0.1.0

data/lib/lockally/api/directory_api.rb

@@ -0,0 +1,484 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module Lockally
+  class DirectoryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get recent directory activity
+    # @param [Hash] opts the optional parameters
+    # @return [GetDirectoryActivity200Response]
+    def get_directory_activity(opts = {})
+      data, _status_code, _headers = get_directory_activity_with_http_info(opts)
+      data
+    end
+
+    # Get recent directory activity
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDirectoryActivity200Response, Integer, Hash)>] GetDirectoryActivity200Response data, response status code and response headers
+    def get_directory_activity_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_activity ...'
+      end
+      # resource path
+      local_var_path = '/v1/directory-activity'
+
+      # 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', 'application/problem+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] || 'GetDirectoryActivity200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.get_directory_activity",
+        :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: DirectoryApi#get_directory_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get directory permission settings
+    # @param [Hash] opts the optional parameters
+    # @return [DirectoryPermissions]
+    def get_directory_permissions(opts = {})
+      data, _status_code, _headers = get_directory_permissions_with_http_info(opts)
+      data
+    end
+
+    # Get directory permission settings
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DirectoryPermissions, Integer, Hash)>] DirectoryPermissions data, response status code and response headers
+    def get_directory_permissions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_permissions ...'
+      end
+      # resource path
+      local_var_path = '/v1/directory-permissions'
+
+      # 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', 'application/problem+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] || 'DirectoryPermissions'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.get_directory_permissions",
+        :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: DirectoryApi#get_directory_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get directory statistics
+    # @param [Hash] opts the optional parameters
+    # @return [GetDirectoryStats200Response]
+    def get_directory_stats(opts = {})
+      data, _status_code, _headers = get_directory_stats_with_http_info(opts)
+      data
+    end
+
+    # Get directory statistics
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDirectoryStats200Response, Integer, Hash)>] GetDirectoryStats200Response data, response status code and response headers
+    def get_directory_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_stats ...'
+      end
+      # resource path
+      local_var_path = '/v1/directory-stats'
+
+      # 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', 'application/problem+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] || 'GetDirectoryStats200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.get_directory_stats",
+        :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: DirectoryApi#get_directory_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Global Address List settings
+    # @param [Hash] opts the optional parameters
+    # @return [GALSettings]
+    def get_gal_settings(opts = {})
+      data, _status_code, _headers = get_gal_settings_with_http_info(opts)
+      data
+    end
+
+    # Get Global Address List settings
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GALSettings, Integer, Hash)>] GALSettings data, response status code and response headers
+    def get_gal_settings_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.get_gal_settings ...'
+      end
+      # resource path
+      local_var_path = '/v1/gal-settings'
+
+      # 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', 'application/problem+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] || 'GALSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.get_gal_settings",
+        :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: DirectoryApi#get_gal_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rebuild the GAL search index
+    # @param [Hash] opts the optional parameters
+    # @return [GALSettings]
+    def rebuild_gal_index(opts = {})
+      data, _status_code, _headers = rebuild_gal_index_with_http_info(opts)
+      data
+    end
+
+    # Rebuild the GAL search index
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GALSettings, Integer, Hash)>] GALSettings data, response status code and response headers
+    def rebuild_gal_index_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.rebuild_gal_index ...'
+      end
+      # resource path
+      local_var_path = '/v1/gal-settings/rebuild-index'
+
+      # 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', 'application/problem+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] || 'GALSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.rebuild_gal_index",
+        :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: DirectoryApi#rebuild_gal_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Sync GAL with external directory sources
+    # @param [Hash] opts the optional parameters
+    # @return [GALSettings]
+    def sync_gal(opts = {})
+      data, _status_code, _headers = sync_gal_with_http_info(opts)
+      data
+    end
+
+    # Sync GAL with external directory sources
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GALSettings, Integer, Hash)>] GALSettings data, response status code and response headers
+    def sync_gal_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.sync_gal ...'
+      end
+      # resource path
+      local_var_path = '/v1/gal-settings/sync'
+
+      # 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', 'application/problem+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] || 'GALSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.sync_gal",
+        :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: DirectoryApi#sync_gal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update directory permission settings
+    # @param update_directory_permissions_request [UpdateDirectoryPermissionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [DirectoryPermissions]
+    def update_directory_permissions(update_directory_permissions_request, opts = {})
+      data, _status_code, _headers = update_directory_permissions_with_http_info(update_directory_permissions_request, opts)
+      data
+    end
+
+    # Update directory permission settings
+    # @param update_directory_permissions_request [UpdateDirectoryPermissionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DirectoryPermissions, Integer, Hash)>] DirectoryPermissions data, response status code and response headers
+    def update_directory_permissions_with_http_info(update_directory_permissions_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.update_directory_permissions ...'
+      end
+      # verify the required parameter 'update_directory_permissions_request' is set
+      if @api_client.config.client_side_validation && update_directory_permissions_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_directory_permissions_request' when calling DirectoryApi.update_directory_permissions"
+      end
+      # resource path
+      local_var_path = '/v1/directory-permissions'
+
+      # 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', 'application/problem+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(update_directory_permissions_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DirectoryPermissions'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.update_directory_permissions",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DirectoryApi#update_directory_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update GAL settings
+    # @param update_gal_settings_request [UpdateGALSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GALSettings]
+    def update_gal_settings(update_gal_settings_request, opts = {})
+      data, _status_code, _headers = update_gal_settings_with_http_info(update_gal_settings_request, opts)
+      data
+    end
+
+    # Update GAL settings
+    # @param update_gal_settings_request [UpdateGALSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GALSettings, Integer, Hash)>] GALSettings data, response status code and response headers
+    def update_gal_settings_with_http_info(update_gal_settings_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DirectoryApi.update_gal_settings ...'
+      end
+      # verify the required parameter 'update_gal_settings_request' is set
+      if @api_client.config.client_side_validation && update_gal_settings_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_gal_settings_request' when calling DirectoryApi.update_gal_settings"
+      end
+      # resource path
+      local_var_path = '/v1/gal-settings'
+
+      # 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', 'application/problem+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(update_gal_settings_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GALSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DirectoryApi.update_gal_settings",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DirectoryApi#update_gal_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end