norbelys 0.1.0

data/lib/norbelys/api/senders_api.rb

@@ -0,0 +1,539 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Norbelys
+  class SendersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Bulk-update senders
+    # Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.
+    # @param bulk_update_senders_input [BulkUpdateSendersInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [BulkUpdateSendersResult]
+    def senders_bulk(bulk_update_senders_input, opts = {})
+      data, _status_code, _headers = senders_bulk_with_http_info(bulk_update_senders_input, opts)
+      data
+    end
+
+    # Bulk-update senders
+    # Apply ONE patch to MANY mailboxes at once, in a single call: pacing (dailyLimit, minGapMinutes), lifecycle (pause/resume via state), warmup, or operator labels. Use this whenever the same change goes to several senders (e.g. 'set every sender to 50/day', 'pause all senders') INSTEAD of calling update once per mailbox. It cannot change credentials or transport, so it never sends a verification email. Returns how many updated plus any per-mailbox errors. Note: a mailbox has NO per-mailbox clock-time send window for campaigns — the daily sending window and timezone belong to the CAMPAIGN (program), so 'make each sender send at a different hour' means splitting senders across campaigns with different windows, not a sender edit.
+    # @param bulk_update_senders_input [BulkUpdateSendersInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(BulkUpdateSendersResult, Integer, Hash)>] BulkUpdateSendersResult data, response status code and response headers
+    def senders_bulk_with_http_info(bulk_update_senders_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_bulk ...'
+      end
+      # verify the required parameter 'bulk_update_senders_input' is set
+      if @api_client.config.client_side_validation && bulk_update_senders_input.nil?
+        fail ArgumentError, "Missing the required parameter 'bulk_update_senders_input' when calling SendersApi.senders_bulk"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_bulk, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/senders/bulk'
+
+      # 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(bulk_update_senders_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BulkUpdateSendersResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_bulk",
+        :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: SendersApi#senders_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Connect a sender
+    # Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.
+    # @param create_sender_input [CreateSenderInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Sender]
+    def senders_create(create_sender_input, opts = {})
+      data, _status_code, _headers = senders_create_with_http_info(create_sender_input, opts)
+      data
+    end
+
+    # Connect a sender
+    # Connect a mailbox from its SMTP/IMAP (or managed-provider) credentials. The save auto-verifies by sending a real test email from the mailbox and is rejected if it cannot send — connecting is verifying, so there is no separate verify or test step. Omit sendingDomainId to get-or-create the sending domain from the fromEmail host.
+    # @param create_sender_input [CreateSenderInput] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Sender, Integer, Hash)>] Sender data, response status code and response headers
+    def senders_create_with_http_info(create_sender_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_create ...'
+      end
+      # verify the required parameter 'create_sender_input' is set
+      if @api_client.config.client_side_validation && create_sender_input.nil?
+        fail ArgumentError, "Missing the required parameter 'create_sender_input' when calling SendersApi.senders_create"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/senders'
+
+      # 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(create_sender_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Sender'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SendersApi#senders_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a sender
+    # Return one mailbox. Use `expand[]=usage` to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and `expand[]=warmup` for the warmup config plus today's slot tally.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [SenderDetail]
+    def senders_find(id, opts = {})
+      data, _status_code, _headers = senders_find_with_http_info(id, opts)
+      data
+    end
+
+    # Get a sender
+    # Return one mailbox. Use &#x60;expand[]&#x3D;usage&#x60; to inline its send/receive/campaign history counts (the preview that drives delete-vs-archive) and &#x60;expand[]&#x3D;warmup&#x60; for the warmup config plus today&#39;s slot tally.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(SenderDetail, Integer, Hash)>] SenderDetail data, response status code and response headers
+    def senders_find_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_find ...'
+      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 SendersApi.senders_find"
+      end
+      allowable_values = ["usage", "warmup"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !opts[:'expand'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"expand\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/senders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SenderDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_find",
+        :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: SendersApi#senders_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List senders
+    # List the mailboxes (senders) on this workspace. Filter by `search` (matches fromName, fromEmail and clientLabel), `state[]`, `reputation[]`, or `sendingDomainId`; the page carries `total` for page / totalPages.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [Array<String>] :reputation 
+    # @option opts [String] :search 
+    # @option opts [String] :sending_domain_id 
+    # @option opts [Array<String>] :state 
+    # @return [SenderList]
+    def senders_list(opts = {})
+      data, _status_code, _headers = senders_list_with_http_info(opts)
+      data
+    end
+
+    # List senders
+    # List the mailboxes (senders) on this workspace. Filter by &#x60;search&#x60; (matches fromName, fromEmail and clientLabel), &#x60;state[]&#x60;, &#x60;reputation[]&#x60;, or &#x60;sendingDomainId&#x60;; the page carries &#x60;total&#x60; for page / totalPages.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [Array<String>] :reputation 
+    # @option opts [String] :search 
+    # @option opts [String] :sending_domain_id 
+    # @option opts [Array<String>] :state 
+    # @return [Array<(SenderList, Integer, Hash)>] SenderList data, response status code and response headers
+    def senders_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendersApi.senders_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SendersApi.senders_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["good", "warning", "bad"]
+      if @api_client.config.client_side_validation && opts[:'reputation'] && !opts[:'reputation'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"reputation\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["healthy", "throttled", "paused"]
+      if @api_client.config.client_side_validation && opts[:'state'] && !opts[:'state'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"state\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/senders'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'reputation'] = @api_client.build_collection_param(opts[:'reputation'], :csv) if !opts[:'reputation'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'sendingDomainId'] = opts[:'sending_domain_id'] if !opts[:'sending_domain_id'].nil?
+      query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :csv) if !opts[:'state'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SenderList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SendersApi#senders_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete or archive a sender
+    # The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response's outcome says which happened. Archived mailboxes can be restored.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SenderRemoveResult]
+    def senders_remove(id, opts = {})
+      data, _status_code, _headers = senders_remove_with_http_info(id, opts)
+      data
+    end
+
+    # Delete or archive a sender
+    # The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response&#39;s outcome says which happened. Archived mailboxes can be restored.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SenderRemoveResult, Integer, Hash)>] SenderRemoveResult data, response status code and response headers
+    def senders_remove_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_remove ...'
+      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 SendersApi.senders_remove"
+      end
+      # resource path
+      local_var_path = '/senders/{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] || 'SenderRemoveResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_remove",
+        :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: SendersApi#senders_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Restore an archived sender
+    # Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Sender]
+    def senders_restore(id, opts = {})
+      data, _status_code, _headers = senders_restore_with_http_info(id, opts)
+      data
+    end
+
+    # Restore an archived sender
+    # Un-archive a mailbox (clears its soft-delete). Connecting is verifying — a restored OAuth mailbox may need to reconnect before it can send again.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Sender, Integer, Hash)>] Sender data, response status code and response headers
+    def senders_restore_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_restore ...'
+      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 SendersApi.senders_restore"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SendersApi.senders_restore, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/senders/{id}/restore'.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']
+      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]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Sender'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_restore",
+        :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: SendersApi#senders_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a sender
+    # Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateSenderInput] :update_sender_input 
+    # @return [Sender]
+    def senders_update(id, opts = {})
+      data, _status_code, _headers = senders_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update a sender
+    # Edit a mailbox. Changing the transport or credentials re-verifies by sending a real test email and is rejected if it cannot send. Set state to pause or resume sending, warmup to tune the warmup engine (or null to disable it), or archivedAt to null to restore an archived mailbox.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateSenderInput] :update_sender_input 
+    # @return [Array<(Sender, Integer, Hash)>] Sender data, response status code and response headers
+    def senders_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SendersApi.senders_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SendersApi.senders_update"
+      end
+      # resource path
+      local_var_path = '/senders/{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(opts[:'update_sender_input'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Sender'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SendersApi.senders_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SendersApi#senders_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end