Skip to content

Latest commit

 

History

History
executable file
·
198 lines (119 loc) · 6.39 KB

AccountsubaccountApi.md

File metadata and controls

executable file
·
198 lines (119 loc) · 6.39 KB

\AccountsubaccountApi

All URIs are relative to https://api.sendpost.io/api/v1

Method HTTP request Description
SubAccountRouterCount Get /account/subaccount/count
SubAccountRouterCreate Post /account/subaccount/
SubAccountRouterDelete Delete /account/subaccount/{subAccountId}
SubAccountRouterGet Get /account/subaccount/{subAccountId}
SubAccountRouterGetAll Get /account/subaccount/
SubAccountRouterUpdate Put /account/subaccount/{subAccountId}

SubAccountRouterCount

ModelsCountStat SubAccountRouterCount(ctx, xAccountApiKey)

Count Total Subaccounts

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key

Return type

ModelsCountStat

Authorization

No authorization required

HTTP request headers

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

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

SubAccountRouterCreate

ModelsSubAccount SubAccountRouterCreate(ctx, xAccountApiKey, body)

Create SubAccount

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key
body ModelsESubAccount The SubAccount content

Return type

ModelsSubAccount

Authorization

No authorization required

HTTP request headers

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

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

SubAccountRouterDelete

ModelsDeleteResponse SubAccountRouterDelete(ctx, xAccountApiKey, subAccountId)

Delete SubAccount

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key
subAccountId int64 The SubAccountId you want to delete

Return type

ModelsDeleteResponse

Authorization

No authorization required

HTTP request headers

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

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

SubAccountRouterGet

ModelsSubAccount SubAccountRouterGet(ctx, xAccountApiKey, subAccountId)

Find SubAccount by SubAccountId

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key
subAccountId int64 the SubAccountId you want to get

Return type

ModelsSubAccount

Authorization

No authorization required

HTTP request headers

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

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

SubAccountRouterGetAll

[]ModelsSubAccount SubAccountRouterGetAll(ctx, xAccountApiKey, optional)

Get All SubAccounts

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key
optional *AccountsubaccountApiSubAccountRouterGetAllOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AccountsubaccountApiSubAccountRouterGetAllOpts struct

Name Type Description Notes

offset | optional.Int64| offset | limit | optional.Int64| limit | search | optional.String| search term |

Return type

[]ModelsSubAccount

Authorization

No authorization required

HTTP request headers

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

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

SubAccountRouterUpdate

ModelsSubAccount SubAccountRouterUpdate(ctx, xAccountApiKey, subAccountId, body)

Update SubAccount

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
xAccountApiKey string Account API Key
subAccountId int64 The SubAccountId you want to update
body ModelsESubAccount The body

Return type

ModelsSubAccount

Authorization

No authorization required

HTTP request headers

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

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