Class: Merge::Ticketing::AttachmentsClient
- Inherits:
-
Object
- Object
- Merge::Ticketing::AttachmentsClient
- Defined in:
- lib/merge_ruby_client/ticketing/attachments/client.rb
Instance Attribute Summary collapse
Instance Method Summary collapse
-
#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Ticketing::TicketingAttachmentResponse
Creates an ‘Attachment` object with the given values.
-
#download_retrieve(id:, mime_type: nil, request_options: nil, &on_data) ⇒ Void
Returns the ‘File` content with the given `id` as a stream of bytes.
- #initialize(request_client:) ⇒ Merge::Ticketing::AttachmentsClient constructor
-
#list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedAttachmentList
Returns a list of ‘Attachment` objects.
-
#meta_post_retrieve(request_options: nil) ⇒ Merge::Ticketing::MetaResponse
Returns metadata for ‘TicketingAttachment` POSTs.
-
#retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil) ⇒ Merge::Ticketing::Attachment
Returns an ‘Attachment` object with the given `id`.
Constructor Details
#initialize(request_client:) ⇒ Merge::Ticketing::AttachmentsClient
20 21 22 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 20 def initialize(request_client:) @request_client = request_client end |
Instance Attribute Details
#request_client ⇒ Merge::RequestClient (readonly)
16 17 18 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 16 def request_client @request_client end |
Instance Method Details
#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Ticketing::TicketingAttachmentResponse
Creates an ‘Attachment` object with the given values.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 106 def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) response = @request_client.conn.post do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["Authorization"] = .api_key unless &.api_key.nil? req.headers["X-Account-Token"] = .account_token unless &.account_token.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req.params = { **(&.additional_query_parameters || {}), "is_debug_mode": is_debug_mode, "run_async": run_async }.compact req.body = { **(&.additional_body_parameters || {}), model: model }.compact req.url "#{@request_client.get_url(request_options: )}/ticketing/v1/attachments" end Merge::Ticketing::TicketingAttachmentResponse.from_json(json_object: response.body) end |
#download_retrieve(id:, mime_type: nil, request_options: nil, &on_data) ⇒ Void
Returns the ‘File` content with the given `id` as a stream of bytes.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 186 def download_retrieve(id:, mime_type: nil, request_options: nil, &on_data) @request_client.conn.get do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["Authorization"] = .api_key unless &.api_key.nil? req.headers["X-Account-Token"] = .account_token unless &.account_token.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req..on_data = on_data req.params = { **(&.additional_query_parameters || {}), "mime_type": mime_type }.compact unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/ticketing/v1/attachments/#{id}/download" end end |
#list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil) ⇒ Merge::Ticketing::PaginatedAttachmentList
Returns a list of ‘Attachment` objects.
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 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 51 def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil) response = @request_client.conn.get do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["Authorization"] = .api_key unless &.api_key.nil? req.headers["X-Account-Token"] = .account_token unless &.account_token.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req.params = { **(&.additional_query_parameters || {}), "created_after": created_after, "created_before": created_before, "cursor": cursor, "expand": , "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "modified_after": modified_after, "modified_before": modified_before, "page_size": page_size, "remote_created_after": remote_created_after, "remote_id": remote_id, "ticket_id": ticket_id }.compact unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/ticketing/v1/attachments" end Merge::Ticketing::PaginatedAttachmentList.from_json(json_object: response.body) end |
#meta_post_retrieve(request_options: nil) ⇒ Merge::Ticketing::MetaResponse
Returns metadata for ‘TicketingAttachment` POSTs.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 216 def (request_options: nil) response = @request_client.conn.get do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["Authorization"] = .api_key unless &.api_key.nil? req.headers["X-Account-Token"] = .account_token unless &.account_token.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/ticketing/v1/attachments/meta/post" end Merge::Ticketing::MetaResponse.from_json(json_object: response.body) end |
#retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil) ⇒ Merge::Ticketing::Attachment
Returns an ‘Attachment` object with the given `id`.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/merge_ruby_client/ticketing/attachments/client.rb', line 143 def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil) response = @request_client.conn.get do |req| req..timeout = .timeout_in_seconds unless &.timeout_in_seconds.nil? req.headers["Authorization"] = .api_key unless &.api_key.nil? req.headers["X-Account-Token"] = .account_token unless &.account_token.nil? req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req.params = { **(&.additional_query_parameters || {}), "expand": , "include_remote_data": include_remote_data }.compact unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/ticketing/v1/attachments/#{id}" end Merge::Ticketing::Attachment.from_json(json_object: response.body) end |