Class: SendX::SenderApi
- Inherits:
-
Object
- Object
- SendX::SenderApi
- Defined in:
- lib/sendx-ruby-sdk/api/sender_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_sender(sender_request, opts = {}) ⇒ Sender
Create Sender Creates a new sender in the system.
-
#create_sender_with_http_info(sender_request, opts = {}) ⇒ Array<(Sender, Integer, Hash)>
Create Sender Creates a new sender in the system.
-
#get_all_senders(opts = {}) ⇒ Array<SenderResponse>
Get All Senders Retrieve all senders for the team, with optional filters like offset, limit, and search.
-
#get_all_senders_with_http_info(opts = {}) ⇒ Array<(Array<SenderResponse>, Integer, Hash)>
Get All Senders Retrieve all senders for the team, with optional filters like offset, limit, and search.
-
#initialize(api_client = ApiClient.default) ⇒ SenderApi
constructor
A new instance of SenderApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/sendx-ruby-sdk/api/sender_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_sender(sender_request, opts = {}) ⇒ Sender
Create Sender Creates a new sender in the system.
27 28 29 30 |
# File 'lib/sendx-ruby-sdk/api/sender_api.rb', line 27 def create_sender(sender_request, opts = {}) data, _status_code, _headers = create_sender_with_http_info(sender_request, opts) data end |
#create_sender_with_http_info(sender_request, opts = {}) ⇒ Array<(Sender, Integer, Hash)>
Create Sender Creates a new sender in the system.
37 38 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/sendx-ruby-sdk/api/sender_api.rb', line 37 def create_sender_with_http_info(sender_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SenderApi.create_sender ...' end # verify the required parameter 'sender_request' is set if @api_client.config.client_side_validation && sender_request.nil? fail ArgumentError, "Missing the required parameter 'sender_request' when calling SenderApi.create_sender" end # resource path local_var_path = '/sender' # 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(sender_request) # return_type return_type = opts[:debug_return_type] || 'Sender' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyAuth'] = opts.merge( :operation => :"SenderApi.create_sender", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SenderApi#create_sender\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_senders(opts = {}) ⇒ Array<SenderResponse>
Get All Senders Retrieve all senders for the team, with optional filters like offset, limit, and search.
97 98 99 100 |
# File 'lib/sendx-ruby-sdk/api/sender_api.rb', line 97 def get_all_senders(opts = {}) data, _status_code, _headers = get_all_senders_with_http_info(opts) data end |
#get_all_senders_with_http_info(opts = {}) ⇒ Array<(Array<SenderResponse>, Integer, Hash)>
Get All Senders Retrieve all senders for the team, with optional filters like offset, limit, and search.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/sendx-ruby-sdk/api/sender_api.rb', line 109 def get_all_senders_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SenderApi.get_all_senders ...' end # resource path local_var_path = '/sender' # query parameters query_params = opts[:query_params] || {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'search'] = opts[:'search'] if !opts[:'search'].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] || 'Array<SenderResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyAuth'] = opts.merge( :operation => :"SenderApi.get_all_senders", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SenderApi#get_all_senders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |