📝 document download function

Author: devmoath

.gitignore

@@ -2,3 +2,4 @@
 /vendor/
 /.phpunit.result.cache
 /composer.lock
+.DS_Store

README.md

@@ -97,6 +97,27 @@ null
 
 ---
 
+#### `download` function
+
+Download an attachment content.
+
+```php
+$attachment = $client->attachments()->get(id: '1000');
+
+$client->attachments()->download(url: $attachment['content']);
+```
+
+<details>
+<summary>response example</summary>
+
+```text
+{"a":"b"}\n
+```
+
+</details>
+
+---
+
 ### `Customers` Resource
 
 #### `create` function

tests/Resources/Attachments.php

@@ -28,12 +28,12 @@
 it('can download an attachment content', function () {
     $client = mockClient(
         method: Method::GET,
-        uri: 'https://www.example.com/jira/attachments/10000',
+        uri: 'https://www.example.com/secure/attachment/4157499/index-1.json',
         response: downloadAttachment(),
         function: 'requestContent'
     );
 
-    $result = $client->attachments()->download(url: 'https://www.example.com/jira/attachments/10000');
+    $result = $client->attachments()->download(url: 'https://www.example.com/secure/attachment/4157499/index-1.json');
 
     expect($result)->toBe(downloadAttachment());
 });