Skip to content

Latest commit

 

History

History
131 lines (83 loc) · 3.97 KB

ProductsApi.md

File metadata and controls

131 lines (83 loc) · 3.97 KB
Raw

BillaBear{{classname}}

All URIs are relative to https://{customerId}.billabear.cloud/api/v1

Method HTTP request Description
CreateProduct Post /product Create
ListProduct Get /product List
ShowProductById Get /product/{productId} Detail
UpdateProduct Put /product/{productId} Update

CreateProduct

string CreateProduct(ctx, body) Create

Create a product

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Product

Return type

string

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

ListProduct

InlineResponse2008 ListProduct(ctx, optional) List

List all products

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ProductsApiListProductOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ProductsApiListProductOpts struct

Name Type Description Notes
limit optional.Int32 How many items to return at one time (max 100)
lastKey optional.String The key to be used in pagination to say what the last key of the previous page was
name optional.String The name to search for

Return type

InlineResponse2008

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ShowProductById

Product ShowProductById(ctx, productId) Detail

Info for a specific product

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
productId string The id of the product to retrieve

Return type

Product

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

UpdateProduct

Product UpdateProduct(ctx, productId) Update

Update a product

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
productId string The id of the product to retrieve

Return type

Product

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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