Skip to content

Latest commit

 

History

History
214 lines (122 loc) · 5.42 KB

SenderIDApi.md

File metadata and controls

214 lines (122 loc) · 5.42 KB
Raw

\SenderIDApi

All URIs are relative to https://ducksms.com

Method HTTP request Description
CreateSender Post /api/v1/senders Create a Sender ID
DeleteSender Delete /api/v1/senders/{id} Delete a Sender ID
GetSender Get /api/v1/senders/{id} Get a single Sender ID
ListSender Get /api/v1/senders List Sender ID
UpdateSender Post /api/v1/senders/{id} Update a Sender ID

CreateSender

CreatedSender CreateSender(ctx, optional)

Create a Sender ID

Create a new sender id

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a CreateSenderOpts struct

Name Type Description Notes
sender optional.Interface of Sender Create a new sender

Return type

CreatedSender

Authorization

BearerToken

HTTP request headers

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

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

DeleteSender

DeletedSender DeleteSender(ctx, id)

Delete a Sender ID

Delete an existing sender id

Required Parameters

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

Return type

DeletedSender

Authorization

BearerToken

HTTP request headers

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

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

GetSender

GetSender GetSender(ctx, id)

Get a single Sender ID

Get details on a single sender id

Required Parameters

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

Return type

GetSender

Authorization

BearerToken

HTTP request headers

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

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

ListSender

ListSender ListSender(ctx, optional)

List Sender ID

List all the senders

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListSenderOpts struct

Name Type Description Notes
page optional.Int32 Page number
filterName optional.String Filter by sender name
filterStatus optional.String Filter by sender status

Return type

ListSender

Authorization

BearerToken

HTTP request headers

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

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

UpdateSender

UpdatedSender UpdateSender(ctx, id, optional)

Update a Sender ID

Update an existing sender id

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a UpdateSenderOpts struct

Name Type Description Notes

sender | optional.Interface of Sender| Update an existing sender id |

Return type

UpdatedSender

Authorization

BearerToken

HTTP request headers

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

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