github.com/moov-io/imagecashletter@v0.10.1/client/docs/ImageCashLetterFilesApi.md (about)

     1  # \ImageCashLetterFilesApi
     2  
     3  All URIs are relative to *http://localhost:8083*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**AddICLToFile**](ImageCashLetterFilesApi.md#AddICLToFile) | **Post** /files/{fileID}/cashLetters | Add cash letter to file
     8  [**CreateICLFile**](ImageCashLetterFilesApi.md#CreateICLFile) | **Post** /files/create | Create file
     9  [**CreateICLFileV2**](ImageCashLetterFilesApi.md#CreateICLFileV2) | **Post** /v2/files | Create file
    10  [**DeleteICLFile**](ImageCashLetterFilesApi.md#DeleteICLFile) | **Delete** /files/{fileID} | Delete file
    11  [**DeleteICLFromFile**](ImageCashLetterFilesApi.md#DeleteICLFromFile) | **Delete** /files/{fileID}/cashLetters/{cashLetterID} | Delete cash letter from file
    12  [**GetICLFileByID**](ImageCashLetterFilesApi.md#GetICLFileByID) | **Get** /files/{fileID} | Retrieve file
    13  [**GetICLFileContents**](ImageCashLetterFilesApi.md#GetICLFileContents) | **Get** /files/{fileID}/contents | Get file contents
    14  [**GetICLFiles**](ImageCashLetterFilesApi.md#GetICLFiles) | **Get** /files | List files
    15  [**Ping**](ImageCashLetterFilesApi.md#Ping) | **Get** /ping | Ping ImageCashLetter service
    16  [**UpdateICLFile**](ImageCashLetterFilesApi.md#UpdateICLFile) | **Post** /files/{fileID} | Update file header
    17  [**ValidateICLFile**](ImageCashLetterFilesApi.md#ValidateICLFile) | **Get** /files/{fileID}/validate | Validate file
    18  
    19  
    20  
    21  ## AddICLToFile
    22  
    23  > AddICLToFile(ctx, fileID, cashLetter, optional)
    24  
    25  Add cash letter to file
    26  
    27  ### Required Parameters
    28  
    29  
    30  Name | Type | Description  | Notes
    31  ------------- | ------------- | ------------- | -------------
    32  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    33  **fileID** | **string**| File ID | 
    34  **cashLetter** | [**CashLetter**](CashLetter.md)|  | 
    35   **optional** | ***AddICLToFileOpts** | optional parameters | nil if no parameters
    36  
    37  ### Optional Parameters
    38  
    39  Optional parameters are passed through a pointer to a AddICLToFileOpts struct
    40  
    41  
    42  Name | Type | Description  | Notes
    43  ------------- | ------------- | ------------- | -------------
    44  
    45  
    46   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
    47  
    48  ### Return type
    49  
    50   (empty response body)
    51  
    52  ### Authorization
    53  
    54  No authorization required
    55  
    56  ### HTTP request headers
    57  
    58  - **Content-Type**: application/json
    59  - **Accept**: Not defined
    60  
    61  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    62  [[Back to Model list]](../README.md#documentation-for-models)
    63  [[Back to README]](../README.md)
    64  
    65  
    66  ## CreateICLFile
    67  
    68  > IclFile CreateICLFile(ctx, createIclFile, optional)
    69  
    70  Create file
    71  
    72  ### Required Parameters
    73  
    74  
    75  Name | Type | Description  | Notes
    76  ------------- | ------------- | ------------- | -------------
    77  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78  **createIclFile** | [**CreateIclFile**](CreateIclFile.md)| Content of the ImageCashLetter file (in json or raw text) | 
    79   **optional** | ***CreateICLFileOpts** | optional parameters | nil if no parameters
    80  
    81  ### Optional Parameters
    82  
    83  Optional parameters are passed through a pointer to a CreateICLFileOpts struct
    84  
    85  
    86  Name | Type | Description  | Notes
    87  ------------- | ------------- | ------------- | -------------
    88  
    89   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
    90  
    91  ### Return type
    92  
    93  [**IclFile**](ICLFile.md)
    94  
    95  ### Authorization
    96  
    97  No authorization required
    98  
    99  ### HTTP request headers
   100  
   101  - **Content-Type**: application/json, text/plain
   102  - **Accept**: application/json
   103  
   104  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   105  [[Back to Model list]](../README.md#documentation-for-models)
   106  [[Back to README]](../README.md)
   107  
   108  
   109  ## CreateICLFileV2
   110  
   111  > IclFile CreateICLFileV2(ctx, createIclFile)
   112  
   113  Create file
   114  
   115  ### Required Parameters
   116  
   117  
   118  Name | Type | Description  | Notes
   119  ------------- | ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121  **createIclFile** | [**CreateIclFile**](CreateIclFile.md)| Content of the ImageCashLetter file in JSON, or X9 (ASCII or EBCDIC) format. Use the `Accept` header to specify the response format.  | 
   122  
   123  ### Return type
   124  
   125  [**IclFile**](ICLFile.md)
   126  
   127  ### Authorization
   128  
   129  No authorization required
   130  
   131  ### HTTP request headers
   132  
   133  - **Content-Type**: application/json, multipart/form-data
   134  - **Accept**: application/json, application/octet-stream, text/plain
   135  
   136  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   137  [[Back to Model list]](../README.md#documentation-for-models)
   138  [[Back to README]](../README.md)
   139  
   140  
   141  ## DeleteICLFile
   142  
   143  > DeleteICLFile(ctx, fileID, optional)
   144  
   145  Delete file
   146  
   147  Permanently deletes a File and associated CashLetters and Bundles. It cannot be undone.
   148  
   149  ### Required Parameters
   150  
   151  
   152  Name | Type | Description  | Notes
   153  ------------- | ------------- | ------------- | -------------
   154  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   155  **fileID** | **string**| File ID | 
   156   **optional** | ***DeleteICLFileOpts** | optional parameters | nil if no parameters
   157  
   158  ### Optional Parameters
   159  
   160  Optional parameters are passed through a pointer to a DeleteICLFileOpts struct
   161  
   162  
   163  Name | Type | Description  | Notes
   164  ------------- | ------------- | ------------- | -------------
   165  
   166   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   167  
   168  ### Return type
   169  
   170   (empty response body)
   171  
   172  ### Authorization
   173  
   174  No authorization required
   175  
   176  ### HTTP request headers
   177  
   178  - **Content-Type**: Not defined
   179  - **Accept**: Not defined
   180  
   181  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   182  [[Back to Model list]](../README.md#documentation-for-models)
   183  [[Back to README]](../README.md)
   184  
   185  
   186  ## DeleteICLFromFile
   187  
   188  > DeleteICLFromFile(ctx, fileID, cashLetterID, optional)
   189  
   190  Delete cash letter from file
   191  
   192  ### Required Parameters
   193  
   194  
   195  Name | Type | Description  | Notes
   196  ------------- | ------------- | ------------- | -------------
   197  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   198  **fileID** | **string**| File ID | 
   199  **cashLetterID** | **string**| CashLetter ID | 
   200   **optional** | ***DeleteICLFromFileOpts** | optional parameters | nil if no parameters
   201  
   202  ### Optional Parameters
   203  
   204  Optional parameters are passed through a pointer to a DeleteICLFromFileOpts struct
   205  
   206  
   207  Name | Type | Description  | Notes
   208  ------------- | ------------- | ------------- | -------------
   209  
   210  
   211   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   212  
   213  ### Return type
   214  
   215   (empty response body)
   216  
   217  ### Authorization
   218  
   219  No authorization required
   220  
   221  ### HTTP request headers
   222  
   223  - **Content-Type**: Not defined
   224  - **Accept**: Not defined
   225  
   226  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   227  [[Back to Model list]](../README.md#documentation-for-models)
   228  [[Back to README]](../README.md)
   229  
   230  
   231  ## GetICLFileByID
   232  
   233  > IclFile GetICLFileByID(ctx, fileID, optional)
   234  
   235  Retrieve file
   236  
   237  Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
   238  
   239  ### Required Parameters
   240  
   241  
   242  Name | Type | Description  | Notes
   243  ------------- | ------------- | ------------- | -------------
   244  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   245  **fileID** | **string**| File ID | 
   246   **optional** | ***GetICLFileByIDOpts** | optional parameters | nil if no parameters
   247  
   248  ### Optional Parameters
   249  
   250  Optional parameters are passed through a pointer to a GetICLFileByIDOpts struct
   251  
   252  
   253  Name | Type | Description  | Notes
   254  ------------- | ------------- | ------------- | -------------
   255  
   256   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   257  
   258  ### Return type
   259  
   260  [**IclFile**](ICLFile.md)
   261  
   262  ### Authorization
   263  
   264  No authorization required
   265  
   266  ### HTTP request headers
   267  
   268  - **Content-Type**: Not defined
   269  - **Accept**: application/json
   270  
   271  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   272  [[Back to Model list]](../README.md#documentation-for-models)
   273  [[Back to README]](../README.md)
   274  
   275  
   276  ## GetICLFileContents
   277  
   278  > string GetICLFileContents(ctx, fileID, optional)
   279  
   280  Get file contents
   281  
   282  Assembles the existing file records (Cash Letters, Bundles, and Controls), computes sequence numbers and totals. Returns plaintext file.
   283  
   284  ### Required Parameters
   285  
   286  
   287  Name | Type | Description  | Notes
   288  ------------- | ------------- | ------------- | -------------
   289  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   290  **fileID** | **string**| File ID | 
   291   **optional** | ***GetICLFileContentsOpts** | optional parameters | nil if no parameters
   292  
   293  ### Optional Parameters
   294  
   295  Optional parameters are passed through a pointer to a GetICLFileContentsOpts struct
   296  
   297  
   298  Name | Type | Description  | Notes
   299  ------------- | ------------- | ------------- | -------------
   300  
   301   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   302  
   303  ### Return type
   304  
   305  **string**
   306  
   307  ### Authorization
   308  
   309  No authorization required
   310  
   311  ### HTTP request headers
   312  
   313  - **Content-Type**: Not defined
   314  - **Accept**: text/plain
   315  
   316  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   317  [[Back to Model list]](../README.md#documentation-for-models)
   318  [[Back to README]](../README.md)
   319  
   320  
   321  ## GetICLFiles
   322  
   323  > []IclFile GetICLFiles(ctx, optional)
   324  
   325  List files
   326  
   327  ### Required Parameters
   328  
   329  
   330  Name | Type | Description  | Notes
   331  ------------- | ------------- | ------------- | -------------
   332  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   333   **optional** | ***GetICLFilesOpts** | optional parameters | nil if no parameters
   334  
   335  ### Optional Parameters
   336  
   337  Optional parameters are passed through a pointer to a GetICLFilesOpts struct
   338  
   339  
   340  Name | Type | Description  | Notes
   341  ------------- | ------------- | ------------- | -------------
   342   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   343  
   344  ### Return type
   345  
   346  [**[]IclFile**](ICLFile.md)
   347  
   348  ### Authorization
   349  
   350  No authorization required
   351  
   352  ### HTTP request headers
   353  
   354  - **Content-Type**: Not defined
   355  - **Accept**: application/json
   356  
   357  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   358  [[Back to Model list]](../README.md#documentation-for-models)
   359  [[Back to README]](../README.md)
   360  
   361  
   362  ## Ping
   363  
   364  > Ping(ctx, )
   365  
   366  Ping ImageCashLetter service
   367  
   368  ### Required Parameters
   369  
   370  This endpoint does not need any parameter.
   371  
   372  ### Return type
   373  
   374   (empty response body)
   375  
   376  ### Authorization
   377  
   378  No authorization required
   379  
   380  ### HTTP request headers
   381  
   382  - **Content-Type**: Not defined
   383  - **Accept**: Not defined
   384  
   385  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   386  [[Back to Model list]](../README.md#documentation-for-models)
   387  [[Back to README]](../README.md)
   388  
   389  
   390  ## UpdateICLFile
   391  
   392  > IclFile UpdateICLFile(ctx, fileID, iclFileHeader, optional)
   393  
   394  Update file header
   395  
   396  Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
   397  
   398  ### Required Parameters
   399  
   400  
   401  Name | Type | Description  | Notes
   402  ------------- | ------------- | ------------- | -------------
   403  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   404  **fileID** | **string**| File ID | 
   405  **iclFileHeader** | [**IclFileHeader**](IclFileHeader.md)|  | 
   406   **optional** | ***UpdateICLFileOpts** | optional parameters | nil if no parameters
   407  
   408  ### Optional Parameters
   409  
   410  Optional parameters are passed through a pointer to a UpdateICLFileOpts struct
   411  
   412  
   413  Name | Type | Description  | Notes
   414  ------------- | ------------- | ------------- | -------------
   415  
   416  
   417   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   418  
   419  ### Return type
   420  
   421  [**IclFile**](ICLFile.md)
   422  
   423  ### Authorization
   424  
   425  No authorization required
   426  
   427  ### HTTP request headers
   428  
   429  - **Content-Type**: application/json
   430  - **Accept**: application/json
   431  
   432  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   433  [[Back to Model list]](../README.md#documentation-for-models)
   434  [[Back to README]](../README.md)
   435  
   436  
   437  ## ValidateICLFile
   438  
   439  > IclFile ValidateICLFile(ctx, fileID, optional)
   440  
   441  Validate file
   442  
   443  Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
   444  
   445  ### Required Parameters
   446  
   447  
   448  Name | Type | Description  | Notes
   449  ------------- | ------------- | ------------- | -------------
   450  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   451  **fileID** | **string**| File ID | 
   452   **optional** | ***ValidateICLFileOpts** | optional parameters | nil if no parameters
   453  
   454  ### Optional Parameters
   455  
   456  Optional parameters are passed through a pointer to a ValidateICLFileOpts struct
   457  
   458  
   459  Name | Type | Description  | Notes
   460  ------------- | ------------- | ------------- | -------------
   461  
   462   **xRequestID** | **optional.String**| Optional Request ID allows application developer to trace requests through the system's logs | 
   463  
   464  ### Return type
   465  
   466  [**IclFile**](ICLFile.md)
   467  
   468  ### Authorization
   469  
   470  No authorization required
   471  
   472  ### HTTP request headers
   473  
   474  - **Content-Type**: Not defined
   475  - **Accept**: application/json
   476  
   477  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   478  [[Back to Model list]](../README.md#documentation-for-models)
   479  [[Back to README]](../README.md)
   480