All URIs are relative to http://localhost:8087
| Method | HTTP request | Description |
|---|---|---|
| DeleteCustomerDocument | Delete /customers/{customerID}/documents/{documentID} | Delete Customer Document |
| GetCustomerDocumentContents | Get /customers/{customerID}/documents/{documentID} | Get Customer Document |
| GetCustomerDocuments | Get /customers/{customerID}/documents | Get Customer Documents |
| UploadCustomerDocument | Post /customers/{customerID}/documents | Upload Customer Document |
DeleteCustomerDocument(ctx, customerID, documentID, optional)
Delete Customer Document
Remove Customer Document
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| customerID | string | ID of the customer that owns the document | |
| documentID | string | ID of the document | |
| optional | *DeleteCustomerDocumentOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DeleteCustomerDocumentOpts struct
| Name | Type | Description | Notes |
|---|
xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File GetCustomerDocumentContents(ctx, customerID, documentID, optional)
Get Customer Document
Retrieve the referenced document
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| customerID | string | customerID of the Customer to get a Document | |
| documentID | string | documentID to identify a Document | |
| optional | *GetCustomerDocumentContentsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetCustomerDocumentContentsOpts struct
| Name | Type | Description | Notes |
|---|
xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |
No authorization required
- Content-Type: Not defined
- Accept: application/pdf, image/_*, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Document GetCustomerDocuments(ctx, customerID, optional)
Get Customer Documents
Get documents for a customer
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| customerID | string | customerID of the Customer to get all Documents | |
| optional | *GetCustomerDocumentsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetCustomerDocumentsOpts struct
| Name | Type | Description | Notes |
|---|
xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Document UploadCustomerDocument(ctx, customerID, type_, file, optional)
Upload Customer Document
Upload a document for the given customer
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| customerID | string | customerID of the Customer to add a document | |
| type_ | string | Document type (see Document type for values) | |
| file | os.Fileos.File | Document to be uploaded | |
| optional | *UploadCustomerDocumentOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UploadCustomerDocumentOpts struct
| Name | Type | Description | Notes |
|---|
xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]