pingram 1.0.31 → 1.0.32

data/lib/pingram/api/broadcasts_api.rb

@@ -0,0 +1,912 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'cgi'
+
+module Pingram
+  class BroadcastsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_archive(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_archive_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_archive_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_archive ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_archive"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/archive'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_archive",
+        :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: BroadcastsApi#broadcasts_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_cancel(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_cancel_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_cancel_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_cancel ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_cancel"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/cancel'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_cancel",
+        :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: BroadcastsApi#broadcasts_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html and cannot be added later. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+    # @param create_broadcast_request [CreateBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_create(create_broadcast_request, opts = {})
+      data, _status_code, _headers = broadcasts_create_with_http_info(create_broadcast_request, opts)
+      data
+    end
+
+    # Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html and cannot be added later. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+    # @param create_broadcast_request [CreateBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_create_with_http_info(create_broadcast_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_create ...'
+      end
+      # verify the required parameter 'create_broadcast_request' is set
+      if @api_client.config.client_side_validation && create_broadcast_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_broadcast_request' when calling BroadcastsApi.broadcasts_create"
+      end
+      # resource path
+      local_var_path = '/broadcasts'
+
+      # 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_broadcast_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_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: BroadcastsApi#broadcasts_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [MessageResponse]
+    def broadcasts_delete(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_delete_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MessageResponse, Integer, Hash)>] MessageResponse data, response status code and response headers
+    def broadcasts_delete_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_delete ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_delete"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'MessageResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_delete",
+        :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: BroadcastsApi#broadcasts_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_get(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_get_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_get_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_get ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_get"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_get",
+        :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: BroadcastsApi#broadcasts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastMetricsResponse]
+    def broadcasts_get_metrics(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_get_metrics_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastMetricsResponse, Integer, Hash)>] BroadcastMetricsResponse data, response status code and response headers
+    def broadcasts_get_metrics_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_get_metrics ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_get_metrics"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/metrics'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastMetricsResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_get_metrics",
+        :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: BroadcastsApi#broadcasts_get_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max broadcasts to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [ListBroadcastsResponse]
+    def broadcasts_list(opts = {})
+      data, _status_code, _headers = broadcasts_list_with_http_info(opts)
+      data
+    end
+
+    # List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max broadcasts to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [Array<(ListBroadcastsResponse, Integer, Hash)>] ListBroadcastsResponse data, response status code and response headers
+    def broadcasts_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_list ...'
+      end
+      # resource path
+      local_var_path = '/broadcasts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].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] || 'ListBroadcastsResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_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: BroadcastsApi#broadcasts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Filter
+    # @option opts [Float] :limit Max recipients to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [ListBroadcastRecipientsResponse]
+    def broadcasts_list_recipients(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_list_recipients_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Filter
+    # @option opts [Float] :limit Max recipients to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [Array<(ListBroadcastRecipientsResponse, Integer, Hash)>] ListBroadcastRecipientsResponse data, response status code and response headers
+    def broadcasts_list_recipients_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_list_recipients ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_list_recipients"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/recipients'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].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] || 'ListBroadcastRecipientsResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_list_recipients",
+        :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: BroadcastsApi#broadcasts_list_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_pause(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_pause_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_pause_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_pause ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_pause"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/pause'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_pause",
+        :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: BroadcastsApi#broadcasts_pause\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_resume(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_resume_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_resume_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_resume ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_resume"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/resume'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_resume",
+        :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: BroadcastsApi#broadcasts_resume\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+    # @param broadcast_id [String] Broadcast ID
+    # @param schedule_broadcast_request [ScheduleBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_schedule(broadcast_id, schedule_broadcast_request, opts = {})
+      data, _status_code, _headers = broadcasts_schedule_with_http_info(broadcast_id, schedule_broadcast_request, opts)
+      data
+    end
+
+    # Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+    # @param broadcast_id [String] Broadcast ID
+    # @param schedule_broadcast_request [ScheduleBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_schedule_with_http_info(broadcast_id, schedule_broadcast_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_schedule ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_schedule"
+      end
+      # verify the required parameter 'schedule_broadcast_request' is set
+      if @api_client.config.client_side_validation && schedule_broadcast_request.nil?
+        fail ArgumentError, "Missing the required parameter 'schedule_broadcast_request' when calling BroadcastsApi.broadcasts_schedule"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/schedule'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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(schedule_broadcast_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_schedule",
+        :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: BroadcastsApi#broadcasts_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_send(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_send_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_send_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_send ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_send"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/send'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_send",
+        :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: BroadcastsApi#broadcasts_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Restore an archived email broadcast to the default broadcast list.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_unarchive(broadcast_id, opts = {})
+      data, _status_code, _headers = broadcasts_unarchive_with_http_info(broadcast_id, opts)
+      data
+    end
+
+    # Restore an archived email broadcast to the default broadcast list.
+    # @param broadcast_id [String] Broadcast ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_unarchive_with_http_info(broadcast_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_unarchive ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_unarchive"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}/unarchive'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_unarchive",
+        :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: BroadcastsApi#broadcasts_unarchive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+    # @param broadcast_id [String] Broadcast ID
+    # @param update_broadcast_request [UpdateBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BroadcastResponse]
+    def broadcasts_update(broadcast_id, update_broadcast_request, opts = {})
+      data, _status_code, _headers = broadcasts_update_with_http_info(broadcast_id, update_broadcast_request, opts)
+      data
+    end
+
+    # Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+    # @param broadcast_id [String] Broadcast ID
+    # @param update_broadcast_request [UpdateBroadcastRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BroadcastResponse, Integer, Hash)>] BroadcastResponse data, response status code and response headers
+    def broadcasts_update_with_http_info(broadcast_id, update_broadcast_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BroadcastsApi.broadcasts_update ...'
+      end
+      # verify the required parameter 'broadcast_id' is set
+      if @api_client.config.client_side_validation && broadcast_id.nil?
+        fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling BroadcastsApi.broadcasts_update"
+      end
+      # verify the required parameter 'update_broadcast_request' is set
+      if @api_client.config.client_side_validation && update_broadcast_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_broadcast_request' when calling BroadcastsApi.broadcasts_update"
+      end
+      # resource path
+      local_var_path = '/broadcasts/{broadcastId}'.sub('{' + 'broadcastId' + '}', CGI.escape(broadcast_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_broadcast_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BroadcastResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"BroadcastsApi.broadcasts_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: BroadcastsApi#broadcasts_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end