Skip to content

Latest commit

 

History

History
160 lines (100 loc) · 4.74 KB

FilesApi.md

File metadata and controls

160 lines (100 loc) · 4.74 KB
Raw

\FilesApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
DocHostDelete Delete /files/{docId} Delete file
DocHostGet Get /files/{docId} Get file
DocHostList Get /files List all files
DocHostUploadV2 Post /files Upload a file
GetHostedImagesPaged Get /files/images/paged Get paged hosted images

DocHostDelete

DocHostDelete(ctx, docId) Delete file

Deletes a users file

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
docId string Id of document

Return type

(empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DocHostGet

HostedDoc DocHostGet(ctx, docId) Get file

Get a single file by id

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
docId string Id of document

Return type

HostedDoc

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DocHostList

[]HostedDoc DocHostList(ctx, ) List all files

List all uploaded user files

Required Parameters

This endpoint does not need any parameter.

Return type

[]HostedDoc

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DocHostUploadV2

[]HostedDoc DocHostUploadV2(ctx, file) Upload a file

Upload a new file

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
file string The file being uploaded

Return type

[]HostedDoc

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHostedImagesPaged

GetHostedImagesPaged(ctx, pageSize, page, optional) Get paged hosted images

Get a specific page of uploaded images available to the user.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
pageSize string The number of items to retrieve in a single db query.
page string Zero-based index of the page of data to retrieve from the db.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
pageSize string The number of items to retrieve in a single db query.
page string Zero-based index of the page of data to retrieve from the db.
search string Filter results with names that match the search term.

Return type

(empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]