class SmoochApi::AttachmentsApi
Attributes
Public Class Methods
# File lib/smooch-api/api/attachments_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Remove an attachment uploaded to Smooch. @param appId Identifies the app. @param attachmentRemoveBody Body for a removeAttachment request. @param [Hash] opts the optional parameters @return [nil]
# File lib/smooch-api/api/attachments_api.rb, line 29 def remove_attachment(appId, attachmentRemoveBody, opts = {}) remove_attachment_with_http_info(appId, attachmentRemoveBody, opts) return nil end
Remove an attachment uploaded to Smooch. @param appId Identifies the app. @param attachmentRemoveBody Body for a removeAttachment request. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/smooch-api/api/attachments_api.rb, line 40 def remove_attachment_with_http_info(appId, attachmentRemoveBody, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AttachmentsApi.remove_attachment ..." end # verify the required parameter 'appId' is set if @api_client.config.client_side_validation && appId.nil? fail ArgumentError, "Missing the required parameter 'appId' when calling AttachmentsApi.remove_attachment" end # verify the required parameter 'attachmentRemoveBody' is set if @api_client.config.client_side_validation && attachmentRemoveBody.nil? fail ArgumentError, "Missing the required parameter 'attachmentRemoveBody' when calling AttachmentsApi.remove_attachment" end # resource path local_var_path = "/v1.1/apps/{appId}/attachments/remove".sub('{' + 'appId' + '}', appId.to_s) # query parameters query_params = {} # header parameters 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']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(attachmentRemoveBody) auth_names = ['basicAuth', 'jwt'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AttachmentsApi#remove_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Upload an attachment to Smooch to use in future messages. @param appId Identifies the app. @param source File to be uploaded @param access Access level for the resulting file @param [Hash] opts the optional parameters @option opts [String] :_for The intended container for the attachment @option opts [String] :appUserId The appUserId of the user that will receive the attachment Used in attachments for messages @option opts [String] :userId The userId of the user that will receive the attachment Used in attachments for messages @return [AttachmentResponse]
# File lib/smooch-api/api/attachments_api.rb, line 93 def upload_attachment(appId, source, access, opts = {}) data, _status_code, _headers = upload_attachment_with_http_info(appId, source, access, opts) return data end
Upload an attachment to Smooch to use in future messages. @param appId Identifies the app. @param source File to be uploaded @param access Access level for the resulting file @param [Hash] opts the optional parameters @option opts [String] :_for The intended container for the attachment @option opts [String] :appUserId The appUserId of the user that will receive the attachment Used in attachments for messages @option opts [String] :userId The userId of the user that will receive the attachment Used in attachments for messages @return [Array<(AttachmentResponse
, Fixnum, Hash)>] AttachmentResponse
data, response status code and response headers
# File lib/smooch-api/api/attachments_api.rb, line 108 def upload_attachment_with_http_info(appId, source, access, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AttachmentsApi.upload_attachment ..." end # verify the required parameter 'appId' is set if @api_client.config.client_side_validation && appId.nil? fail ArgumentError, "Missing the required parameter 'appId' when calling AttachmentsApi.upload_attachment" end # verify the required parameter 'source' is set if @api_client.config.client_side_validation && source.nil? fail ArgumentError, "Missing the required parameter 'source' when calling AttachmentsApi.upload_attachment" end # verify the required parameter 'access' is set if @api_client.config.client_side_validation && access.nil? fail ArgumentError, "Missing the required parameter 'access' when calling AttachmentsApi.upload_attachment" end # resource path local_var_path = "/v1.1/apps/{appId}/attachments".sub('{' + 'appId' + '}', appId.to_s) # query parameters query_params = {} query_params[:'access'] = access query_params[:'for'] = opts[:'_for'] if !opts[:'_for'].nil? query_params[:'appUserId'] = opts[:'appUserId'] if !opts[:'appUserId'].nil? query_params[:'userId'] = opts[:'userId'] if !opts[:'userId'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params["source"] = source # http body (model) post_body = nil auth_names = ['basicAuth', 'jwt'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AttachmentResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AttachmentsApi#upload_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end