Class: Svix::BroadcastApi

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/api/broadcast_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BroadcastApi

Returns a new instance of BroadcastApi.



19
20
21
 
# File 'lib/svix/api/broadcast_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/svix/api/broadcast_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_broadcast_message(message_broadcast_in, opts = {}) ⇒ MessageBroadcastOut

Create Broadcast Message Creates a background task to send the same message to each application in your organization

Parameters:

  • message_broadcast_in (MessageBroadcastIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request's idempotency key

Returns:



28
29
30
31
 
# File 'lib/svix/api/broadcast_api.rb', line 28

def create_broadcast_message(message_broadcast_in, opts = {})
  data, _status_code, _headers = create_broadcast_message_with_http_info(message_broadcast_in, opts)
  data
end

#create_broadcast_message_with_http_info(message_broadcast_in, opts = {}) ⇒ Array<(MessageBroadcastOut, Integer, Hash)>

Create Broadcast Message Creates a background task to send the same message to each application in your organization

Parameters:

  • message_broadcast_in (MessageBroadcastIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

  • (Array<(MessageBroadcastOut, Integer, Hash)>) —

    MessageBroadcastOut data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/svix/api/broadcast_api.rb', line 39

def create_broadcast_message_with_http_info(message_broadcast_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BroadcastApi.create_broadcast_message ...'
  end
  # verify the required parameter 'message_broadcast_in' is set
  if @api_client.config.client_side_validation && message_broadcast_in.nil?
    fail ArgumentError, "Missing the required parameter 'message_broadcast_in' when calling BroadcastApi.create_broadcast_message"
  end
  # resource path
  local_var_path = '/api/v1/msg/broadcast'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  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(message_broadcast_in)

  # return_type
  return_type = opts[:debug_return_type] || 'MessageBroadcastOut'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['HTTPBearer']

  new_options = opts.merge(
    :operation => :"BroadcastApi.create_broadcast_message",
    :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: BroadcastApi#create_broadcast_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end