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

     1  # Go API client for openapi
     2  
     3  Moov Image Cash Letter (ICL) implements an HTTP API for creating, parsing, and validating ImageCashLetter files.
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
     7  
     8  - API version: v1
     9  - Package version: 1.0.0
    10  - Build package: org.openapitools.codegen.languages.GoClientCodegen
    11  For more information, please visit [https://github.com/moov-io/imagecashletter](https://github.com/moov-io/imagecashletter)
    12  
    13  ## Installation
    14  
    15  Install the following dependencies:
    16  
    17  ```shell
    18  go get github.com/stretchr/testify/assert
    19  go get golang.org/x/oauth2
    20  go get golang.org/x/net/context
    21  go get github.com/antihax/optional
    22  ```
    23  
    24  Put the package under your project folder and add the following in import:
    25  
    26  ```golang
    27  import "./openapi"
    28  ```
    29  
    30  ## Documentation for API Endpoints
    31  
    32  All URIs are relative to *http://localhost:8083*
    33  
    34  Class | Method | HTTP request | Description
    35  ------------ | ------------- | ------------- | -------------
    36  *ImageCashLetterFilesApi* | [**AddICLToFile**](docs/ImageCashLetterFilesApi.md#addicltofile) | **Post** /files/{fileID}/cashLetters | Add cash letter to file
    37  *ImageCashLetterFilesApi* | [**CreateICLFile**](docs/ImageCashLetterFilesApi.md#createiclfile) | **Post** /files/create | Create file
    38  *ImageCashLetterFilesApi* | [**CreateICLFileV2**](docs/ImageCashLetterFilesApi.md#createiclfilev2) | **Post** /v2/files | Create file
    39  *ImageCashLetterFilesApi* | [**DeleteICLFile**](docs/ImageCashLetterFilesApi.md#deleteiclfile) | **Delete** /files/{fileID} | Delete file
    40  *ImageCashLetterFilesApi* | [**DeleteICLFromFile**](docs/ImageCashLetterFilesApi.md#deleteiclfromfile) | **Delete** /files/{fileID}/cashLetters/{cashLetterID} | Delete cash letter from file
    41  *ImageCashLetterFilesApi* | [**GetICLFileByID**](docs/ImageCashLetterFilesApi.md#geticlfilebyid) | **Get** /files/{fileID} | Retrieve file
    42  *ImageCashLetterFilesApi* | [**GetICLFileContents**](docs/ImageCashLetterFilesApi.md#geticlfilecontents) | **Get** /files/{fileID}/contents | Get file contents
    43  *ImageCashLetterFilesApi* | [**GetICLFiles**](docs/ImageCashLetterFilesApi.md#geticlfiles) | **Get** /files | List files
    44  *ImageCashLetterFilesApi* | [**Ping**](docs/ImageCashLetterFilesApi.md#ping) | **Get** /ping | Ping ImageCashLetter service
    45  *ImageCashLetterFilesApi* | [**UpdateICLFile**](docs/ImageCashLetterFilesApi.md#updateiclfile) | **Post** /files/{fileID} | Update file header
    46  *ImageCashLetterFilesApi* | [**ValidateICLFile**](docs/ImageCashLetterFilesApi.md#validateiclfile) | **Get** /files/{fileID}/validate | Validate file
    47  
    48  
    49  ## Documentation For Models
    50  
    51   - [Bundle](docs/Bundle.md)
    52   - [BundleControl](docs/BundleControl.md)
    53   - [BundleHeader](docs/BundleHeader.md)
    54   - [CashLetter](docs/CashLetter.md)
    55   - [CashLetterControl](docs/CashLetterControl.md)
    56   - [CashLetterHeader](docs/CashLetterHeader.md)
    57   - [CheckDetailAddendumA](docs/CheckDetailAddendumA.md)
    58   - [CheckDetailAddendumB](docs/CheckDetailAddendumB.md)
    59   - [CheckDetailAddendumC](docs/CheckDetailAddendumC.md)
    60   - [Checks](docs/Checks.md)
    61   - [CreateIclFile](docs/CreateIclFile.md)
    62   - [CreditItem](docs/CreditItem.md)
    63   - [Error](docs/Error.md)
    64   - [IclFile](docs/IclFile.md)
    65   - [IclFileControl](docs/IclFileControl.md)
    66   - [IclFileHeader](docs/IclFileHeader.md)
    67   - [ImageViewAnalysis](docs/ImageViewAnalysis.md)
    68   - [ImageViewData](docs/ImageViewData.md)
    69   - [ImageViewDetail](docs/ImageViewDetail.md)
    70   - [ReturnDetailAddendumA](docs/ReturnDetailAddendumA.md)
    71   - [ReturnDetailAddendumB](docs/ReturnDetailAddendumB.md)
    72   - [ReturnDetailAddendumC](docs/ReturnDetailAddendumC.md)
    73   - [ReturnDetailAddendumD](docs/ReturnDetailAddendumD.md)
    74   - [Returns](docs/Returns.md)
    75   - [RoutingNumberSummary](docs/RoutingNumberSummary.md)
    76  
    77  
    78  ## Documentation For Authorization
    79  
    80   Endpoints do not require authorization.
    81  
    82  
    83  
    84  ## Author
    85  
    86  
    87