Class: SunshineConversationsClient::AttachmentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/attachments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AttachmentsApi 



16
17
18
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete_attachment(app_id, attachment_delete_body, opts = {}) ⇒ Object

Delete Attachment Remove an attachment uploaded to Sunshine Conversations through the Upload attachment API. See [Attachments for Messages](#section/Attachments-for-Messages) to have attachments automatically deleted when deleting messages, conversations or users. <aside class="notice"><strong>Note:</strong> Deleted attachments can remain available on our CDN’s cache up to 15 minutes after the delete call.</aside>



25
26
27
28
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 25

def delete_attachment(app_id, attachment_delete_body, opts = {})
  data, _status_code, _headers = delete_attachment_with_http_info(app_id, attachment_delete_body, opts)
  data
end

#delete_attachment_with_http_info(app_id, attachment_delete_body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Attachment Remove an attachment uploaded to Sunshine Conversations through the Upload attachment API. See [Attachments for Messages](#section/Attachments-for-Messages) to have attachments automatically deleted when deleting messages, conversations or users. &lt;aside class&#x3D;&quot;notice&quot;&gt;&lt;strong&gt;Note:&lt;/strong&gt; Deleted attachments can remain available on our CDN&#39;s cache up to 15 minutes after the delete call.&lt;/aside&gt;



36
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
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 36

def delete_attachment_with_http_info(app_id, attachment_delete_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AttachmentsApi.delete_attachment ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling AttachmentsApi.delete_attachment"
  end
  # verify the required parameter 'attachment_delete_body' is set
  if @api_client.config.client_side_validation && attachment_delete_body.nil?
    fail ArgumentError, "Missing the required parameter 'attachment_delete_body' when calling AttachmentsApi.delete_attachment"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/attachments/remove'.sub('{' + 'appId' + '}', CGI.escape(app_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(attachment_delete_body) 

  # return_type
  return_type = opts[:return_type] || 'Object' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

#upload_attachment(app_id, access, source, opts = {}) ⇒ AttachmentResponse

Upload Attachment Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class="notice"><strong>Note:</strong> Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href="support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc">file validation</a> guide for more details.</aside>

Options Hash (opts):

  • :_for (String) —

    Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details.

  • :conversation_id (String) —

    Links the attachment getting uploaded to the conversation ID.



98
99
100
101
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 98

def upload_attachment(app_id, access, source, opts = {})
  data, _status_code, _headers = upload_attachment_with_http_info(app_id, access, source, opts)
  data
end

#upload_attachment_with_http_info(app_id, access, source, opts = {}) ⇒ Array<(AttachmentResponse, Integer, Hash)>

Upload Attachment Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. &lt;aside class&#x3D;&quot;notice&quot;&gt;&lt;strong&gt;Note:&lt;/strong&gt; Sunshine Conversations limits the size and type of file you can upload to the platform. See the &lt;a href&#x3D;&quot;support.zendesk.com/hc/en-us/articles/8435939957914#topic_v1r_rwr_mdc&quot;&gt;file validation&lt;/a&gt; guide for more details.&lt;/aside&gt;

Options Hash (opts):

  • :_for (String) —

    Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details.

  • :conversation_id (String) —

    Links the attachment getting uploaded to the conversation ID.



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/sunshine-conversations-client/api/attachments_api.rb', line 112

def upload_attachment_with_http_info(app_id, access, source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AttachmentsApi.upload_attachment ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' 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
  # 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
  # resource path
  local_var_path = '/v2/apps/{appId}/attachments'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'access'] = access
  query_params[:'for'] = opts[:'_for'] if !opts[:'_for'].nil?
  query_params[:'conversationId'] = opts[:'conversation_id'] if !opts[:'conversation_id'].nil?

  # 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(['multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['source'] = source

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'AttachmentResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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