lockally 0.1.0 → 0.3.0

data/lib/lockally/api/suppressions_api.rb

@@ -1,7 +1,7 @@
 =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 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>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **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
@@ -19,29 +19,29 @@ module Lockally
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Remove a suppression
-    # @param email [String] 
+    # Add a suppression
+    # @param create_suppression_request [CreateSuppressionRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def v1_suppressions_email_delete(email, opts = {})
-      v1_suppressions_email_delete_with_http_info(email, opts)
-      nil
+    # @return [Suppression]
+    def create_suppression(create_suppression_request, opts = {})
+      data, _status_code, _headers = create_suppression_with_http_info(create_suppression_request, opts)
+      data
     end
 
-    # Remove a suppression
-    # @param email [String] 
+    # Add a suppression
+    # @param create_suppression_request [CreateSuppressionRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def v1_suppressions_email_delete_with_http_info(email, opts = {})
+    # @return [Array<(Suppression, Integer, Hash)>] Suppression data, response status code and response headers
+    def create_suppression_with_http_info(create_suppression_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_email_delete ...'
+        @api_client.config.logger.debug 'Calling API: SuppressionsApi.create_suppression ...'
       end
-      # verify the required parameter 'email' is set
-      if @api_client.config.client_side_validation && email.nil?
-        fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.v1_suppressions_email_delete"
+      # verify the required parameter 'create_suppression_request' is set
+      if @api_client.config.client_side_validation && create_suppression_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_suppression_request' when calling SuppressionsApi.create_suppression"
       end
       # resource path
-      local_var_path = '/v1/suppressions/{email}'.sub('{email}', CGI.escape(email.to_s))
+      local_var_path = '/v1/suppressions'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -49,22 +49,27 @@ module Lockally
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
+      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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_suppression_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'Suppression'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SuppressionsApi.v1_suppressions_email_delete",
+        :operation => :"SuppressionsApi.create_suppression",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -73,33 +78,33 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      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: SuppressionsApi#v1_suppressions_email_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SuppressionsApi#create_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Check whether an address is suppressed
+    # Remove a suppression
     # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Suppression]
-    def v1_suppressions_email_get(email, opts = {})
-      data, _status_code, _headers = v1_suppressions_email_get_with_http_info(email, opts)
-      data
+    # @return [nil]
+    def delete_suppression(email, opts = {})
+      delete_suppression_with_http_info(email, opts)
+      nil
     end
 
-    # Check whether an address is suppressed
+    # Remove a suppression
     # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Suppression, Integer, Hash)>] Suppression data, response status code and response headers
-    def v1_suppressions_email_get_with_http_info(email, opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_suppression_with_http_info(email, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_email_get ...'
+        @api_client.config.logger.debug 'Calling API: SuppressionsApi.delete_suppression ...'
       end
       # verify the required parameter 'email' is set
       if @api_client.config.client_side_validation && email.nil?
-        fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.v1_suppressions_email_get"
+        fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.delete_suppression"
       end
       # resource path
       local_var_path = '/v1/suppressions/{email}'.sub('{email}', CGI.escape(email.to_s))
@@ -110,7 +115,7 @@ module Lockally
       # 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']
+      header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -119,13 +124,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Suppression'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SuppressionsApi.v1_suppressions_email_get",
+        :operation => :"SuppressionsApi.delete_suppression",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -134,50 +139,39 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: SuppressionsApi#v1_suppressions_email_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SuppressionsApi#delete_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List suppressed recipients
+    # Check whether an address is suppressed
+    # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :reason 
-    # @option opts [String] :cursor 
-    # @option opts [Integer] :limit  (default to 50)
-    # @return [V1SuppressionsGet200Response]
-    def v1_suppressions_get(opts = {})
-      data, _status_code, _headers = v1_suppressions_get_with_http_info(opts)
+    # @return [Suppression]
+    def get_suppression(email, opts = {})
+      data, _status_code, _headers = get_suppression_with_http_info(email, opts)
       data
     end
 
-    # List suppressed recipients
+    # Check whether an address is suppressed
+    # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :reason 
-    # @option opts [String] :cursor 
-    # @option opts [Integer] :limit  (default to 50)
-    # @return [Array<(V1SuppressionsGet200Response, Integer, Hash)>] V1SuppressionsGet200Response data, response status code and response headers
-    def v1_suppressions_get_with_http_info(opts = {})
+    # @return [Array<(Suppression, Integer, Hash)>] Suppression data, response status code and response headers
+    def get_suppression_with_http_info(email, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_get ...'
+        @api_client.config.logger.debug 'Calling API: SuppressionsApi.get_suppression ...'
       end
-      allowable_values = ["unsubscribe", "complaint", "bounce", "manual"]
-      if @api_client.config.client_side_validation && opts[:'reason'] && !allowable_values.include?(opts[:'reason'])
-        fail ArgumentError, "invalid value for \"reason\", must be one of #{allowable_values}"
-      end
-      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
-        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SuppressionsApi.v1_suppressions_get, must be smaller than or equal to 200.'
+      # verify the required parameter 'email' is set
+      if @api_client.config.client_side_validation && email.nil?
+        fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.get_suppression"
       end
-
       # resource path
-      local_var_path = '/v1/suppressions'
+      local_var_path = '/v1/suppressions/{email}'.sub('{email}', CGI.escape(email.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'reason'] = opts[:'reason'] if !opts[:'reason'].nil?
-      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -191,13 +185,13 @@ module Lockally
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'V1SuppressionsGet200Response'
+      return_type = opts[:debug_return_type] || 'Suppression'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SuppressionsApi.v1_suppressions_get",
+        :operation => :"SuppressionsApi.get_suppression",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -208,62 +202,68 @@ module Lockally
 
       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: SuppressionsApi#v1_suppressions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SuppressionsApi#get_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Add a suppression
-    # @param v1_suppressions_post_request [V1SuppressionsPostRequest] 
+    # List suppressed recipients
     # @param [Hash] opts the optional parameters
-    # @return [Suppression]
-    def v1_suppressions_post(v1_suppressions_post_request, opts = {})
-      data, _status_code, _headers = v1_suppressions_post_with_http_info(v1_suppressions_post_request, opts)
+    # @option opts [String] :reason 
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [ListSuppressions200Response]
+    def list_suppressions(opts = {})
+      data, _status_code, _headers = list_suppressions_with_http_info(opts)
       data
     end
 
-    # Add a suppression
-    # @param v1_suppressions_post_request [V1SuppressionsPostRequest] 
+    # List suppressed recipients
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Suppression, Integer, Hash)>] Suppression data, response status code and response headers
-    def v1_suppressions_post_with_http_info(v1_suppressions_post_request, opts = {})
+    # @option opts [String] :reason 
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [Array<(ListSuppressions200Response, Integer, Hash)>] ListSuppressions200Response data, response status code and response headers
+    def list_suppressions_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_post ...'
+        @api_client.config.logger.debug 'Calling API: SuppressionsApi.list_suppressions ...'
       end
-      # verify the required parameter 'v1_suppressions_post_request' is set
-      if @api_client.config.client_side_validation && v1_suppressions_post_request.nil?
-        fail ArgumentError, "Missing the required parameter 'v1_suppressions_post_request' when calling SuppressionsApi.v1_suppressions_post"
+      allowable_values = ["unsubscribe", "complaint", "bounce", "manual"]
+      if @api_client.config.client_side_validation && opts[:'reason'] && !allowable_values.include?(opts[:'reason'])
+        fail ArgumentError, "invalid value for \"reason\", must be one of #{allowable_values}"
       end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SuppressionsApi.list_suppressions, must be smaller than or equal to 200.'
+      end
+
       # resource path
       local_var_path = '/v1/suppressions'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'reason'] = opts[:'reason'] if !opts[:'reason'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # 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(v1_suppressions_post_request)
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Suppression'
+      return_type = opts[:debug_return_type] || 'ListSuppressions200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['bearerAuth']
 
       new_options = opts.merge(
-        :operation => :"SuppressionsApi.v1_suppressions_post",
+        :operation => :"SuppressionsApi.list_suppressions",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -272,9 +272,9 @@ module Lockally
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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: SuppressionsApi#v1_suppressions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: SuppressionsApi#list_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end