zyphr 0.1.71 → 0.1.72

data/lib/zyphr/api/inbound_email_api.rb

@@ -19,6 +19,135 @@ module Zyphr
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create an inbox
+    # Create a named receiving address, `<local_part>@inbound.<domain>`, on a domain with inbound email enabled. Test-mode keys cannot create, update or delete inboxes, because inboxes change live mail routing. Once a domain has at least one inbox, mail to any other address on it is dropped; a domain with no inboxes keeps receiving at every address. Requires a plan with inbound email (Starter or higher). 
+    # @param create_inbox_request [CreateInboxRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InboxResponse]
+    def create_inbox(create_inbox_request, opts = {})
+      data, _status_code, _headers = create_inbox_with_http_info(create_inbox_request, opts)
+      data
+    end
+
+    # Create an inbox
+    # Create a named receiving address, &#x60;&lt;local_part&gt;@inbound.&lt;domain&gt;&#x60;, on a domain with inbound email enabled. Test-mode keys cannot create, update or delete inboxes, because inboxes change live mail routing. Once a domain has at least one inbox, mail to any other address on it is dropped; a domain with no inboxes keeps receiving at every address. Requires a plan with inbound email (Starter or higher). 
+    # @param create_inbox_request [CreateInboxRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxResponse, Integer, Hash)>] InboxResponse data, response status code and response headers
+    def create_inbox_with_http_info(create_inbox_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.create_inbox ...'
+      end
+      # verify the required parameter 'create_inbox_request' is set
+      if @api_client.config.client_side_validation && create_inbox_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_inbox_request' when calling InboundEmailApi.create_inbox"
+      end
+      # resource path
+      local_var_path = '/inboxes'
+
+      # 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(create_inbox_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InboxResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.create_inbox",
+        :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: InboundEmailApi#create_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an inbox
+    # Delete the inbox. Mail it already received is kept (its `inbox_id` becomes null). If it was the domain's last inbox, the domain goes back to receiving at every address. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_inbox(id, opts = {})
+      delete_inbox_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete an inbox
+    # Delete the inbox. Mail it already received is kept (its &#x60;inbox_id&#x60; becomes null). If it was the domain&#39;s last inbox, the domain goes back to receiving at every address. 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_inbox_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.delete_inbox ...'
+      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 InboundEmailApi.delete_inbox"
+      end
+      # resource path
+      local_var_path = '/inboxes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # 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] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.delete_inbox",
+        :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: InboundEmailApi#delete_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get an attachment download URL
     # Return a short-lived presigned S3 download URL for one attachment of a received email. `attachmentId` is the positional id from the email's `attachments` array. 
     # @param id [String] 
@@ -151,6 +280,67 @@ module Zyphr
       return data, status_code, headers
     end
 
+    # Get an inbox
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [InboxResponse]
+    def get_inbox(id, opts = {})
+      data, _status_code, _headers = get_inbox_with_http_info(id, opts)
+      data
+    end
+
+    # Get an inbox
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxResponse, Integer, Hash)>] InboxResponse data, response status code and response headers
+    def get_inbox_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.get_inbox ...'
+      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 InboundEmailApi.get_inbox"
+      end
+      # resource path
+      local_var_path = '/inboxes/{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] || 'InboxResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.get_inbox",
+        :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: InboundEmailApi#get_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List received emails
     # List inbound (received) emails for the project, newest first. By default only delivered mail (`received`/`processed`) is returned; pass `include_withheld=true` to also see quarantined/dropped. 
     # @param [Hash] opts the optional parameters
@@ -230,5 +420,211 @@ module Zyphr
       end
       return data, status_code, headers
     end
+
+    # List inboxes
+    # @param [Hash] opts the optional parameters
+    # @return [InboxListResponse]
+    def list_inboxes(opts = {})
+      data, _status_code, _headers = list_inboxes_with_http_info(opts)
+      data
+    end
+
+    # List inboxes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxListResponse, Integer, Hash)>] InboxListResponse data, response status code and response headers
+    def list_inboxes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.list_inboxes ...'
+      end
+      # resource path
+      local_var_path = '/inboxes'
+
+      # 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] || 'InboxListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.list_inboxes",
+        :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: InboundEmailApi#list_inboxes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reply to a received email
+    # Send a reply to a received email that threads under the original in the recipient's mail client. Zyphr sets `to` (the original sender), the `Re:` subject, and the `In-Reply-To` / `References` headers from the received email; any of those fields in the body are ignored. Everything else behaves exactly like `POST /emails` (`html`/`text`, `send_at`/`delay`, quotas, suppression). Templates are not supported, because a template's own subject would break threading. Quarantined or dropped mail cannot be replied to. 
+    # @param id [String] 
+    # @param reply_to_inbound_email_request [ReplyToInboundEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 
+    # @return [SendEmailResponse]
+    def reply_to_inbound_email(id, reply_to_inbound_email_request, opts = {})
+      data, _status_code, _headers = reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts)
+      data
+    end
+
+    # Reply to a received email
+    # Send a reply to a received email that threads under the original in the recipient&#39;s mail client. Zyphr sets &#x60;to&#x60; (the original sender), the &#x60;Re:&#x60; subject, and the &#x60;In-Reply-To&#x60; / &#x60;References&#x60; headers from the received email; any of those fields in the body are ignored. Everything else behaves exactly like &#x60;POST /emails&#x60; (&#x60;html&#x60;/&#x60;text&#x60;, &#x60;send_at&#x60;/&#x60;delay&#x60;, quotas, suppression). Templates are not supported, because a template&#39;s own subject would break threading. Quarantined or dropped mail cannot be replied to. 
+    # @param id [String] 
+    # @param reply_to_inbound_email_request [ReplyToInboundEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 
+    # @return [Array<(SendEmailResponse, Integer, Hash)>] SendEmailResponse data, response status code and response headers
+    def reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.reply_to_inbound_email ...'
+      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 InboundEmailApi.reply_to_inbound_email"
+      end
+      # verify the required parameter 'reply_to_inbound_email_request' is set
+      if @api_client.config.client_side_validation && reply_to_inbound_email_request.nil?
+        fail ArgumentError, "Missing the required parameter 'reply_to_inbound_email_request' when calling InboundEmailApi.reply_to_inbound_email"
+      end
+      # resource path
+      local_var_path = '/inbound-emails/{id}/reply'.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
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(reply_to_inbound_email_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendEmailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.reply_to_inbound_email",
+        :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: InboundEmailApi#reply_to_inbound_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an inbox
+    # Rename the inbox or change the display name recipients see. The address cannot change.
+    # @param id [String] 
+    # @param update_inbox_request [UpdateInboxRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InboxResponse]
+    def update_inbox(id, update_inbox_request, opts = {})
+      data, _status_code, _headers = update_inbox_with_http_info(id, update_inbox_request, opts)
+      data
+    end
+
+    # Update an inbox
+    # Rename the inbox or change the display name recipients see. The address cannot change.
+    # @param id [String] 
+    # @param update_inbox_request [UpdateInboxRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboxResponse, Integer, Hash)>] InboxResponse data, response status code and response headers
+    def update_inbox_with_http_info(id, update_inbox_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundEmailApi.update_inbox ...'
+      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 InboundEmailApi.update_inbox"
+      end
+      # verify the required parameter 'update_inbox_request' is set
+      if @api_client.config.client_side_validation && update_inbox_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_inbox_request' when calling InboundEmailApi.update_inbox"
+      end
+      # resource path
+      local_var_path = '/inboxes/{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(update_inbox_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InboxResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"InboundEmailApi.update_inbox",
+        :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: InboundEmailApi#update_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end