github.com/grokify/go-ringcentral-client@v0.3.31/engagedigital/v1/client/docs/AttachmentsApi.md (about)

     1  # \AttachmentsApi
     2  
     3  All URIs are relative to *https://DOMAIN.api.engagement.dimelo.com/1.0*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAttachment**](AttachmentsApi.md#CreateAttachment) | **Post** /attachments | Creating an attachment
     8  [**GetAllAttachments**](AttachmentsApi.md#GetAllAttachments) | **Get** /attachments | Getting all attachments
     9  [**GetAttachment**](AttachmentsApi.md#GetAttachment) | **Get** /attachments/{attachmentId} | Getting an attachment from its id
    10  
    11  
    12  
    13  ## CreateAttachment
    14  
    15  > Attachment CreateAttachment(ctx, optional)
    16  Creating an attachment
    17  
    18  This method allows you to create an new attachment.
    19  
    20  ### Required Parameters
    21  
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26   **optional** | ***CreateAttachmentOpts** | optional parameters | nil if no parameters
    27  
    28  ### Optional Parameters
    29  
    30  Optional parameters are passed through a pointer to a CreateAttachmentOpts struct
    31  
    32  
    33  Name | Type | Description  | Notes
    34  ------------- | ------------- | ------------- | -------------
    35   **file** | **optional.Interface of *os.File****optional.*os.File**|  | 
    36   **private** | **optional.String**|  | 
    37  
    38  ### Return type
    39  
    40  [**Attachment**](Attachment.md)
    41  
    42  ### Authorization
    43  
    44  No authorization required
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: multipart/form-data:
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## GetAllAttachments
    57  
    58  > GetAllAttachmentsResponse GetAllAttachments(ctx, optional)
    59  Getting all attachments
    60  
    61  This method renders attachments ordered by creation date (descending).
    62  
    63  ### Required Parameters
    64  
    65  
    66  Name | Type | Description  | Notes
    67  ------------- | ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69   **optional** | ***GetAllAttachmentsOpts** | optional parameters | nil if no parameters
    70  
    71  ### Optional Parameters
    72  
    73  Optional parameters are passed through a pointer to a GetAllAttachmentsOpts struct
    74  
    75  
    76  Name | Type | Description  | Notes
    77  ------------- | ------------- | ------------- | -------------
    78   **offset** | **optional.Int32**| The record index to start. Default value is 0. | 
    79   **limit** | **optional.Int32**| The max number of records to return. Default value is 30, max value is 150. | 
    80  
    81  ### Return type
    82  
    83  [**GetAllAttachmentsResponse**](GetAllAttachmentsResponse.md)
    84  
    85  ### Authorization
    86  
    87  No authorization required
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## GetAttachment
   100  
   101  > Attachment GetAttachment(ctx, attachmentId)
   102  Getting an attachment from its id
   103  
   104  This method renders an attachment from given id.
   105  
   106  ### Required Parameters
   107  
   108  
   109  Name | Type | Description  | Notes
   110  ------------- | ------------- | ------------- | -------------
   111  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   112  **attachmentId** | **string**|  | 
   113  
   114  ### Return type
   115  
   116  [**Attachment**](Attachment.md)
   117  
   118  ### Authorization
   119  
   120  No authorization required
   121  
   122  ### HTTP request headers
   123  
   124  - **Content-Type**: Not defined
   125  - **Accept**: application/json
   126  
   127  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   128  [[Back to Model list]](../README.md#documentation-for-models)
   129  [[Back to README]](../README.md)
   130