Documentation
¶
Overview ¶
Package client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/hostinger/public-api-generator/cli version (devel) DO NOT EDIT.
Index ¶
- func NewCreateFolderRequest(server string, mailboxResourceId string, body CreateFolderJSONRequestBody) (*http.Request, error)
- func NewCreateFolderRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateWebhookRequest(server string, mailboxResourceId string, body CreateWebhookJSONRequestBody) (*http.Request, error)
- func NewCreateWebhookRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeleteAllMessagesRequest(server string, mailboxResourceId string, folder string) (*http.Request, error)
- func NewDeleteFolderRequest(server string, mailboxResourceId string, folder string) (*http.Request, error)
- func NewDeleteMessageRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
- func NewDeleteMessagesRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewDeleteMessagesRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, ...) (*http.Request, error)
- func NewDeleteWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
- func NewGetCurrentAccountRequest(server string) (*http.Request, error)
- func NewGetMessageAttachmentRequest(server string, mailboxResourceId string, folder string, uid int, ...) (*http.Request, error)
- func NewGetMessageRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
- func NewGetMessageSourceRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
- func NewGetMessageTextRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
- func NewGetQuotaRequest(server string, mailboxResourceId string) (*http.Request, error)
- func NewGetWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
- func NewListFoldersRequest(server string, mailboxResourceId string, params *ListFoldersParams) (*http.Request, error)
- func NewListMessagesRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewListWebhooksRequest(server string, mailboxResourceId string, params *ListWebhooksParams) (*http.Request, error)
- func NewMoveMessageRequest(server string, mailboxResourceId string, folder string, uid int, ...) (*http.Request, error)
- func NewMoveMessageRequestWithBody(server string, mailboxResourceId string, folder string, uid int, ...) (*http.Request, error)
- func NewMoveMessagesRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewMoveMessagesRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, ...) (*http.Request, error)
- func NewPatchMessageRequest(server string, mailboxResourceId string, folder string, uid int, ...) (*http.Request, error)
- func NewPatchMessageRequestWithBody(server string, mailboxResourceId string, folder string, uid int, ...) (*http.Request, error)
- func NewRegenerateWebhookSecretRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
- func NewSearchMessagesRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewSearchMessagesRequestWithBody(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewSendEmailRequest(server string, mailboxResourceId string, body SendEmailJSONRequestBody) (*http.Request, error)
- func NewSendEmailRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
- func NewTestWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
- func NewUpdateFolderRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewUpdateFolderRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, ...) (*http.Request, error)
- func NewUpdateMessageFlagsRequest(server string, mailboxResourceId string, folder string, ...) (*http.Request, error)
- func NewUpdateMessageFlagsRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, ...) (*http.Request, error)
- func NewUpdateWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Request, error)
- func NewUpdateWebhookRequestWithBody(server string, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Request, error)
- type Client
- func (c *Client) CreateFolder(ctx context.Context, mailboxResourceId string, ...) (*http.Response, error)
- func (c *Client) CreateFolderWithBody(ctx context.Context, mailboxResourceId string, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateWebhook(ctx context.Context, mailboxResourceId string, ...) (*http.Response, error)
- func (c *Client) CreateWebhookWithBody(ctx context.Context, mailboxResourceId string, contentType string, ...) (*http.Response, error)
- func (c *Client) DeleteAllMessages(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) DeleteFolder(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) DeleteMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) DeleteMessages(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) DeleteMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) DeleteWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- func (c *Client) GetCurrentAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) GetMessageAttachment(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) GetMessageSource(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) GetMessageText(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) GetQuota(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- func (c *Client) ListFolders(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, ...) (*http.Response, error)
- func (c *Client) ListMessages(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) ListWebhooks(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, ...) (*http.Response, error)
- func (c *Client) MoveMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) MoveMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) MoveMessages(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) MoveMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) PatchMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) PatchMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*http.Response, error)
- func (c *Client) RegenerateWebhookSecret(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- func (c *Client) SearchMessages(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) SearchMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) SendEmail(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SendEmailWithBody(ctx context.Context, mailboxResourceId string, contentType string, ...) (*http.Response, error)
- func (c *Client) TestWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- func (c *Client) UpdateFolder(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) UpdateFolderWithBody(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) UpdateMessageFlags(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) UpdateMessageFlagsWithBody(ctx context.Context, mailboxResourceId string, folder string, ...) (*http.Response, error)
- func (c *Client) UpdateWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- func (c *Client) UpdateWebhookWithBody(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) CreateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, ...) (*CreateFolderResponse, error)
- func (c *ClientWithResponses) CreateFolderWithResponse(ctx context.Context, mailboxResourceId string, ...) (*CreateFolderResponse, error)
- func (c *ClientWithResponses) CreateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, ...) (*CreateWebhookResponse, error)
- func (c *ClientWithResponses) CreateWebhookWithResponse(ctx context.Context, mailboxResourceId string, ...) (*CreateWebhookResponse, error)
- func (c *ClientWithResponses) DeleteAllMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*DeleteAllMessagesResponse, error)
- func (c *ClientWithResponses) DeleteFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*DeleteFolderResponse, error)
- func (c *ClientWithResponses) DeleteMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*DeleteMessageResponse, error)
- func (c *ClientWithResponses) DeleteMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*DeleteMessagesResponse, error)
- func (c *ClientWithResponses) DeleteMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*DeleteMessagesResponse, error)
- func (c *ClientWithResponses) DeleteWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*DeleteWebhookResponse, error)
- func (c *ClientWithResponses) GetCurrentAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCurrentAccountResponse, error)
- func (c *ClientWithResponses) GetMessageAttachmentWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*GetMessageAttachmentResponse, error)
- func (c *ClientWithResponses) GetMessageSourceWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*GetMessageSourceResponse, error)
- func (c *ClientWithResponses) GetMessageTextWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*GetMessageTextResponse, error)
- func (c *ClientWithResponses) GetMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*GetMessageResponse, error)
- func (c *ClientWithResponses) GetQuotaWithResponse(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*GetQuotaResponse, error)
- func (c *ClientWithResponses) GetWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*GetWebhookResponse, error)
- func (c *ClientWithResponses) ListFoldersWithResponse(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, ...) (*ListFoldersResponse, error)
- func (c *ClientWithResponses) ListMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*ListMessagesResponse, error)
- func (c *ClientWithResponses) ListWebhooksWithResponse(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, ...) (*ListWebhooksResponse, error)
- func (c *ClientWithResponses) MoveMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*MoveMessageResponse, error)
- func (c *ClientWithResponses) MoveMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*MoveMessageResponse, error)
- func (c *ClientWithResponses) MoveMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*MoveMessagesResponse, error)
- func (c *ClientWithResponses) MoveMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*MoveMessagesResponse, error)
- func (c *ClientWithResponses) PatchMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*PatchMessageResponse, error)
- func (c *ClientWithResponses) PatchMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, ...) (*PatchMessageResponse, error)
- func (c *ClientWithResponses) RegenerateWebhookSecretWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*RegenerateWebhookSecretResponse, error)
- func (c *ClientWithResponses) SearchMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*SearchMessagesResponse, error)
- func (c *ClientWithResponses) SearchMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*SearchMessagesResponse, error)
- func (c *ClientWithResponses) SendEmailWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, ...) (*SendEmailResponse, error)
- func (c *ClientWithResponses) SendEmailWithResponse(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, ...) (*SendEmailResponse, error)
- func (c *ClientWithResponses) TestWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*TestWebhookResponse, error)
- func (c *ClientWithResponses) UpdateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*UpdateFolderResponse, error)
- func (c *ClientWithResponses) UpdateFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*UpdateFolderResponse, error)
- func (c *ClientWithResponses) UpdateMessageFlagsWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*UpdateMessageFlagsResponse, error)
- func (c *ClientWithResponses) UpdateMessageFlagsWithResponse(ctx context.Context, mailboxResourceId string, folder string, ...) (*UpdateMessageFlagsResponse, error)
- func (c *ClientWithResponses) UpdateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*UpdateWebhookResponse, error)
- func (c *ClientWithResponses) UpdateWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, ...) (*UpdateWebhookResponse, error)
- type ClientWithResponsesInterface
- type CommonResponseBadGatewayResponse
- type CommonResponseConflictResponse
- type CommonResponseForbiddenResponse
- type CommonResponseInternalServerErrorResponse
- type CommonResponseNotFoundResponse
- type CommonResponseUnauthorizedResponse
- type CommonResponseValidationFailedResponse
- type CreateFolderJSONRequestBody
- type CreateFolderResponse
- func (r CreateFolderResponse) ContentType() string
- func (r CreateFolderResponse) GetBody() []byte
- func (r CreateFolderResponse) GetJSON201() *V1FoldersResource
- func (r CreateFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r CreateFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r CreateFolderResponse) GetJSON409() *CommonResponseConflictResponse
- func (r CreateFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r CreateFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r CreateFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r CreateFolderResponse) Status() string
- func (r CreateFolderResponse) StatusCode() int
- type CreateWebhookJSONRequestBody
- type CreateWebhookResponse
- func (r CreateWebhookResponse) ContentType() string
- func (r CreateWebhookResponse) GetBody() []byte
- func (r CreateWebhookResponse) GetJSON201() *V1WebhooksResourceWithSecret
- func (r CreateWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r CreateWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r CreateWebhookResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r CreateWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r CreateWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r CreateWebhookResponse) Status() string
- func (r CreateWebhookResponse) StatusCode() int
- type DeleteAllMessagesResponse
- func (r DeleteAllMessagesResponse) ContentType() string
- func (r DeleteAllMessagesResponse) GetBody() []byte
- func (r DeleteAllMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r DeleteAllMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r DeleteAllMessagesResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r DeleteAllMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r DeleteAllMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r DeleteAllMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r DeleteAllMessagesResponse) Status() string
- func (r DeleteAllMessagesResponse) StatusCode() int
- type DeleteFolderResponse
- func (r DeleteFolderResponse) ContentType() string
- func (r DeleteFolderResponse) GetBody() []byte
- func (r DeleteFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r DeleteFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r DeleteFolderResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r DeleteFolderResponse) GetJSON409() *CommonResponseConflictResponse
- func (r DeleteFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r DeleteFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r DeleteFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r DeleteFolderResponse) Status() string
- func (r DeleteFolderResponse) StatusCode() int
- type DeleteMessageResponse
- func (r DeleteMessageResponse) ContentType() string
- func (r DeleteMessageResponse) GetBody() []byte
- func (r DeleteMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r DeleteMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r DeleteMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r DeleteMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r DeleteMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r DeleteMessageResponse) Status() string
- func (r DeleteMessageResponse) StatusCode() int
- type DeleteMessagesJSONRequestBody
- type DeleteMessagesResponse
- func (r DeleteMessagesResponse) ContentType() string
- func (r DeleteMessagesResponse) GetBody() []byte
- func (r DeleteMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r DeleteMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r DeleteMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r DeleteMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r DeleteMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r DeleteMessagesResponse) Status() string
- func (r DeleteMessagesResponse) StatusCode() int
- type DeleteWebhookResponse
- func (r DeleteWebhookResponse) ContentType() string
- func (r DeleteWebhookResponse) GetBody() []byte
- func (r DeleteWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r DeleteWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r DeleteWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r DeleteWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r DeleteWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r DeleteWebhookResponse) Status() string
- func (r DeleteWebhookResponse) StatusCode() int
- type Error
- type GetCurrentAccountResponse
- func (r GetCurrentAccountResponse) ContentType() string
- func (r GetCurrentAccountResponse) GetBody() []byte
- func (r GetCurrentAccountResponse) GetJSON200() *V1MeResource
- func (r GetCurrentAccountResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetCurrentAccountResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetCurrentAccountResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetCurrentAccountResponse) Status() string
- func (r GetCurrentAccountResponse) StatusCode() int
- type GetMessageAttachmentResponse
- func (r GetMessageAttachmentResponse) ContentType() string
- func (r GetMessageAttachmentResponse) GetBody() []byte
- func (r GetMessageAttachmentResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetMessageAttachmentResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetMessageAttachmentResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r GetMessageAttachmentResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r GetMessageAttachmentResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetMessageAttachmentResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetMessageAttachmentResponse) Status() string
- func (r GetMessageAttachmentResponse) StatusCode() int
- type GetMessageResponse
- func (r GetMessageResponse) ContentType() string
- func (r GetMessageResponse) GetBody() []byte
- func (r GetMessageResponse) GetJSON200() *V1FolderMessagesResource
- func (r GetMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetMessageResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r GetMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r GetMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetMessageResponse) Status() string
- func (r GetMessageResponse) StatusCode() int
- type GetMessageSourceResponse
- func (r GetMessageSourceResponse) ContentType() string
- func (r GetMessageSourceResponse) GetBody() []byte
- func (r GetMessageSourceResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetMessageSourceResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetMessageSourceResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r GetMessageSourceResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r GetMessageSourceResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetMessageSourceResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetMessageSourceResponse) Status() string
- func (r GetMessageSourceResponse) StatusCode() int
- type GetMessageTextResponse
- func (r GetMessageTextResponse) ContentType() string
- func (r GetMessageTextResponse) GetBody() []byte
- func (r GetMessageTextResponse) GetJSON200() *V1FolderMessagesMessageTextResource
- func (r GetMessageTextResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetMessageTextResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetMessageTextResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r GetMessageTextResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r GetMessageTextResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetMessageTextResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetMessageTextResponse) Status() string
- func (r GetMessageTextResponse) StatusCode() int
- type GetQuotaResponse
- func (r GetQuotaResponse) ContentType() string
- func (r GetQuotaResponse) GetBody() []byte
- func (r GetQuotaResponse) GetJSON200() *V1QuotaResource
- func (r GetQuotaResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetQuotaResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetQuotaResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetQuotaResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetQuotaResponse) Status() string
- func (r GetQuotaResponse) StatusCode() int
- type GetWebhookResponse
- func (r GetWebhookResponse) ContentType() string
- func (r GetWebhookResponse) GetBody() []byte
- func (r GetWebhookResponse) GetJSON200() *V1WebhooksResource
- func (r GetWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r GetWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r GetWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r GetWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r GetWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r GetWebhookResponse) Status() string
- func (r GetWebhookResponse) StatusCode() int
- type HttpRequestDoer
- type ListFoldersParams
- type ListFoldersResponse
- func (r ListFoldersResponse) ContentType() string
- func (r ListFoldersResponse) GetBody() []byte
- func (r ListFoldersResponse) GetJSON200() *V1FoldersCollection
- func (r ListFoldersResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r ListFoldersResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r ListFoldersResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r ListFoldersResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r ListFoldersResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r ListFoldersResponse) Status() string
- func (r ListFoldersResponse) StatusCode() int
- type ListMessagesParams
- type ListMessagesResponse
- func (r ListMessagesResponse) ContentType() string
- func (r ListMessagesResponse) GetBody() []byte
- func (r ListMessagesResponse) GetJSON200() *V1FolderMessagesCollection
- func (r ListMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r ListMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r ListMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r ListMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r ListMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r ListMessagesResponse) Status() string
- func (r ListMessagesResponse) StatusCode() int
- type ListWebhooksParams
- type ListWebhooksParamsStatus
- type ListWebhooksResponse
- func (r ListWebhooksResponse) ContentType() string
- func (r ListWebhooksResponse) GetBody() []byte
- func (r ListWebhooksResponse) GetJSON200() *V1WebhooksCollection
- func (r ListWebhooksResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r ListWebhooksResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r ListWebhooksResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r ListWebhooksResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r ListWebhooksResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r ListWebhooksResponse) Status() string
- func (r ListWebhooksResponse) StatusCode() int
- type MoveMessageJSONRequestBody
- type MoveMessageResponse
- func (r MoveMessageResponse) ContentType() string
- func (r MoveMessageResponse) GetBody() []byte
- func (r MoveMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r MoveMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r MoveMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r MoveMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r MoveMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r MoveMessageResponse) Status() string
- func (r MoveMessageResponse) StatusCode() int
- type MoveMessagesJSONRequestBody
- type MoveMessagesResponse
- func (r MoveMessagesResponse) ContentType() string
- func (r MoveMessagesResponse) GetBody() []byte
- func (r MoveMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r MoveMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r MoveMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r MoveMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r MoveMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r MoveMessagesResponse) Status() string
- func (r MoveMessagesResponse) StatusCode() int
- type Pagination
- type PatchMessageJSONRequestBody
- type PatchMessageResponse
- func (r PatchMessageResponse) ContentType() string
- func (r PatchMessageResponse) GetBody() []byte
- func (r PatchMessageResponse) GetJSON200() *V1FolderMessagesResource
- func (r PatchMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r PatchMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r PatchMessageResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r PatchMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r PatchMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r PatchMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r PatchMessageResponse) Status() string
- func (r PatchMessageResponse) StatusCode() int
- type RegenerateWebhookSecretResponse
- func (r RegenerateWebhookSecretResponse) ContentType() string
- func (r RegenerateWebhookSecretResponse) GetBody() []byte
- func (r RegenerateWebhookSecretResponse) GetJSON200() *V1WebhooksResourceWithSecret
- func (r RegenerateWebhookSecretResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r RegenerateWebhookSecretResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r RegenerateWebhookSecretResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r RegenerateWebhookSecretResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r RegenerateWebhookSecretResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r RegenerateWebhookSecretResponse) Status() string
- func (r RegenerateWebhookSecretResponse) StatusCode() int
- type RequestEditorFn
- type SearchMessagesJSONRequestBody
- type SearchMessagesParams
- type SearchMessagesResponse
- func (r SearchMessagesResponse) ContentType() string
- func (r SearchMessagesResponse) GetBody() []byte
- func (r SearchMessagesResponse) GetJSON200() *V1FolderMessagesCollection
- func (r SearchMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r SearchMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r SearchMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r SearchMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r SearchMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r SearchMessagesResponse) Status() string
- func (r SearchMessagesResponse) StatusCode() int
- type SendEmailJSONRequestBody
- type SendEmailResponse
- func (r SendEmailResponse) ContentType() string
- func (r SendEmailResponse) GetBody() []byte
- func (r SendEmailResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r SendEmailResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r SendEmailResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r SendEmailResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r SendEmailResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r SendEmailResponse) Status() string
- func (r SendEmailResponse) StatusCode() int
- type TestWebhookResponse
- func (r TestWebhookResponse) ContentType() string
- func (r TestWebhookResponse) GetBody() []byte
- func (r TestWebhookResponse) GetJSON200() *V1WebhooksTestResult
- func (r TestWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r TestWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r TestWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r TestWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r TestWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r TestWebhookResponse) Status() string
- func (r TestWebhookResponse) StatusCode() int
- type UpdateFolderJSONRequestBody
- type UpdateFolderResponse
- func (r UpdateFolderResponse) ContentType() string
- func (r UpdateFolderResponse) GetBody() []byte
- func (r UpdateFolderResponse) GetJSON200() *V1FoldersResource
- func (r UpdateFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r UpdateFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r UpdateFolderResponse) GetJSON409() *CommonResponseConflictResponse
- func (r UpdateFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r UpdateFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r UpdateFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r UpdateFolderResponse) Status() string
- func (r UpdateFolderResponse) StatusCode() int
- type UpdateMessageFlagsJSONRequestBody
- type UpdateMessageFlagsResponse
- func (r UpdateMessageFlagsResponse) ContentType() string
- func (r UpdateMessageFlagsResponse) GetBody() []byte
- func (r UpdateMessageFlagsResponse) GetJSON200() *V1FolderMessagesUpdateFlagsResult
- func (r UpdateMessageFlagsResponse) GetJSON207() *V1FolderMessagesUpdateFlagsResult
- func (r UpdateMessageFlagsResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r UpdateMessageFlagsResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r UpdateMessageFlagsResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r UpdateMessageFlagsResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r UpdateMessageFlagsResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r UpdateMessageFlagsResponse) Status() string
- func (r UpdateMessageFlagsResponse) StatusCode() int
- type UpdateWebhookJSONRequestBody
- type UpdateWebhookResponse
- func (r UpdateWebhookResponse) ContentType() string
- func (r UpdateWebhookResponse) GetBody() []byte
- func (r UpdateWebhookResponse) GetJSON200() *V1WebhooksResource
- func (r UpdateWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
- func (r UpdateWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
- func (r UpdateWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
- func (r UpdateWebhookResponse) GetJSON422() *CommonResponseValidationFailedResponse
- func (r UpdateWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
- func (r UpdateWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
- func (r UpdateWebhookResponse) Status() string
- func (r UpdateWebhookResponse) StatusCode() int
- type V1FolderMessagesCollection
- type V1FolderMessagesDeleteBulkRequest
- type V1FolderMessagesFlagsBulkRequest
- type V1FolderMessagesFlagsRequest
- type V1FolderMessagesMessage
- type V1FolderMessagesMessageAddress
- type V1FolderMessagesMessageAttachment
- type V1FolderMessagesMessageText
- type V1FolderMessagesMessageTextResource
- type V1FolderMessagesMessage_From
- func (t V1FolderMessagesMessage_From) AsV1FolderMessagesMessageAddress() (V1FolderMessagesMessageAddress, error)
- func (t *V1FolderMessagesMessage_From) FromV1FolderMessagesMessageAddress(v V1FolderMessagesMessageAddress) error
- func (t V1FolderMessagesMessage_From) MarshalJSON() ([]byte, error)
- func (t *V1FolderMessagesMessage_From) MergeV1FolderMessagesMessageAddress(v V1FolderMessagesMessageAddress) error
- func (t *V1FolderMessagesMessage_From) UnmarshalJSON(b []byte) error
- type V1FolderMessagesMoveBulkRequest
- type V1FolderMessagesMoveRequest
- type V1FolderMessagesResource
- type V1FolderMessagesSearchRequest
- type V1FolderMessagesUpdateFlagsResult
- type V1FoldersCollection
- type V1FoldersCreateRequest
- type V1FoldersFolder
- type V1FoldersResource
- type V1FoldersUpdateRequest
- type V1MeMailbox
- type V1MeResource
- type V1QuotaQuota
- type V1QuotaQuotaResource
- type V1QuotaResource
- type V1SendAttachment
- type V1SendMessageRef
- type V1SendRequest
- func (t V1SendRequest) AsV1SendRequest0() (V1SendRequest0, error)
- func (t V1SendRequest) AsV1SendRequest1() (V1SendRequest1, error)
- func (t V1SendRequest) AsV1SendRequest2() (V1SendRequest2, error)
- func (t *V1SendRequest) FromV1SendRequest0(v V1SendRequest0) error
- func (t *V1SendRequest) FromV1SendRequest1(v V1SendRequest1) error
- func (t *V1SendRequest) FromV1SendRequest2(v V1SendRequest2) error
- func (t V1SendRequest) MarshalJSON() ([]byte, error)
- func (t *V1SendRequest) MergeV1SendRequest0(v V1SendRequest0) error
- func (t *V1SendRequest) MergeV1SendRequest1(v V1SendRequest1) error
- func (t *V1SendRequest) MergeV1SendRequest2(v V1SendRequest2) error
- func (t *V1SendRequest) UnmarshalJSON(b []byte) error
- type V1SendRequest0
- type V1SendRequest1
- type V1SendRequest2
- type V1WebhooksCollection
- type V1WebhooksCreateRequest
- type V1WebhooksCreateRequestEvents
- type V1WebhooksCreateRequestStatus
- type V1WebhooksResource
- type V1WebhooksResourceWithSecret
- type V1WebhooksTestResult
- type V1WebhooksUpdateRequest
- type V1WebhooksUpdateRequestEvents
- type V1WebhooksUpdateRequestStatus
- type V1WebhooksWebhook
- type V1WebhooksWebhookEvents
- type V1WebhooksWebhookStatus
- type V1WebhooksWebhookWithSecret
- type V1WebhooksWebhookWithSecretEvents
- type V1WebhooksWebhookWithSecretStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCreateFolderRequest ¶
func NewCreateFolderRequest(server string, mailboxResourceId string, body CreateFolderJSONRequestBody) (*http.Request, error)
NewCreateFolderRequest calls the generic CreateFolder builder with application/json body
func NewCreateFolderRequestWithBody ¶
func NewCreateFolderRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
NewCreateFolderRequestWithBody constructs an http.Request for the CreateFolder method, with any body, and a specified content type
func NewCreateWebhookRequest ¶
func NewCreateWebhookRequest(server string, mailboxResourceId string, body CreateWebhookJSONRequestBody) (*http.Request, error)
NewCreateWebhookRequest calls the generic CreateWebhook builder with application/json body
func NewCreateWebhookRequestWithBody ¶
func NewCreateWebhookRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
NewCreateWebhookRequestWithBody constructs an http.Request for the CreateWebhook method, with any body, and a specified content type
func NewDeleteAllMessagesRequest ¶
func NewDeleteAllMessagesRequest(server string, mailboxResourceId string, folder string) (*http.Request, error)
NewDeleteAllMessagesRequest constructs an http.Request for the DeleteAllMessages method
func NewDeleteFolderRequest ¶
func NewDeleteFolderRequest(server string, mailboxResourceId string, folder string) (*http.Request, error)
NewDeleteFolderRequest constructs an http.Request for the DeleteFolder method
func NewDeleteMessageRequest ¶
func NewDeleteMessageRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
NewDeleteMessageRequest constructs an http.Request for the DeleteMessage method
func NewDeleteMessagesRequest ¶
func NewDeleteMessagesRequest(server string, mailboxResourceId string, folder string, body DeleteMessagesJSONRequestBody) (*http.Request, error)
NewDeleteMessagesRequest calls the generic DeleteMessages builder with application/json body
func NewDeleteMessagesRequestWithBody ¶
func NewDeleteMessagesRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, body io.Reader) (*http.Request, error)
NewDeleteMessagesRequestWithBody constructs an http.Request for the DeleteMessages method, with any body, and a specified content type
func NewDeleteWebhookRequest ¶
func NewDeleteWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
NewDeleteWebhookRequest constructs an http.Request for the DeleteWebhook method
func NewGetCurrentAccountRequest ¶
NewGetCurrentAccountRequest constructs an http.Request for the GetCurrentAccount method
func NewGetMessageAttachmentRequest ¶
func NewGetMessageAttachmentRequest(server string, mailboxResourceId string, folder string, uid int, attachmentId string) (*http.Request, error)
NewGetMessageAttachmentRequest constructs an http.Request for the GetMessageAttachment method
func NewGetMessageRequest ¶
func NewGetMessageRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
NewGetMessageRequest constructs an http.Request for the GetMessage method
func NewGetMessageSourceRequest ¶
func NewGetMessageSourceRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
NewGetMessageSourceRequest constructs an http.Request for the GetMessageSource method
func NewGetMessageTextRequest ¶
func NewGetMessageTextRequest(server string, mailboxResourceId string, folder string, uid int) (*http.Request, error)
NewGetMessageTextRequest constructs an http.Request for the GetMessageText method
func NewGetQuotaRequest ¶
NewGetQuotaRequest constructs an http.Request for the GetQuota method
func NewGetWebhookRequest ¶
func NewGetWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
NewGetWebhookRequest constructs an http.Request for the GetWebhook method
func NewListFoldersRequest ¶
func NewListFoldersRequest(server string, mailboxResourceId string, params *ListFoldersParams) (*http.Request, error)
NewListFoldersRequest constructs an http.Request for the ListFolders method
func NewListMessagesRequest ¶
func NewListMessagesRequest(server string, mailboxResourceId string, folder string, params *ListMessagesParams) (*http.Request, error)
NewListMessagesRequest constructs an http.Request for the ListMessages method
func NewListWebhooksRequest ¶
func NewListWebhooksRequest(server string, mailboxResourceId string, params *ListWebhooksParams) (*http.Request, error)
NewListWebhooksRequest constructs an http.Request for the ListWebhooks method
func NewMoveMessageRequest ¶
func NewMoveMessageRequest(server string, mailboxResourceId string, folder string, uid int, body MoveMessageJSONRequestBody) (*http.Request, error)
NewMoveMessageRequest calls the generic MoveMessage builder with application/json body
func NewMoveMessageRequestWithBody ¶
func NewMoveMessageRequestWithBody(server string, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader) (*http.Request, error)
NewMoveMessageRequestWithBody constructs an http.Request for the MoveMessage method, with any body, and a specified content type
func NewMoveMessagesRequest ¶
func NewMoveMessagesRequest(server string, mailboxResourceId string, folder string, body MoveMessagesJSONRequestBody) (*http.Request, error)
NewMoveMessagesRequest calls the generic MoveMessages builder with application/json body
func NewMoveMessagesRequestWithBody ¶
func NewMoveMessagesRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, body io.Reader) (*http.Request, error)
NewMoveMessagesRequestWithBody constructs an http.Request for the MoveMessages method, with any body, and a specified content type
func NewPatchMessageRequest ¶
func NewPatchMessageRequest(server string, mailboxResourceId string, folder string, uid int, body PatchMessageJSONRequestBody) (*http.Request, error)
NewPatchMessageRequest calls the generic PatchMessage builder with application/json body
func NewPatchMessageRequestWithBody ¶
func NewPatchMessageRequestWithBody(server string, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader) (*http.Request, error)
NewPatchMessageRequestWithBody constructs an http.Request for the PatchMessage method, with any body, and a specified content type
func NewRegenerateWebhookSecretRequest ¶
func NewRegenerateWebhookSecretRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
NewRegenerateWebhookSecretRequest constructs an http.Request for the RegenerateWebhookSecret method
func NewSearchMessagesRequest ¶
func NewSearchMessagesRequest(server string, mailboxResourceId string, folder string, params *SearchMessagesParams, body SearchMessagesJSONRequestBody) (*http.Request, error)
NewSearchMessagesRequest calls the generic SearchMessages builder with application/json body
func NewSearchMessagesRequestWithBody ¶
func NewSearchMessagesRequestWithBody(server string, mailboxResourceId string, folder string, params *SearchMessagesParams, contentType string, body io.Reader) (*http.Request, error)
NewSearchMessagesRequestWithBody constructs an http.Request for the SearchMessages method, with any body, and a specified content type
func NewSendEmailRequest ¶
func NewSendEmailRequest(server string, mailboxResourceId string, body SendEmailJSONRequestBody) (*http.Request, error)
NewSendEmailRequest calls the generic SendEmail builder with application/json body
func NewSendEmailRequestWithBody ¶
func NewSendEmailRequestWithBody(server string, mailboxResourceId string, contentType string, body io.Reader) (*http.Request, error)
NewSendEmailRequestWithBody constructs an http.Request for the SendEmail method, with any body, and a specified content type
func NewTestWebhookRequest ¶
func NewTestWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID) (*http.Request, error)
NewTestWebhookRequest constructs an http.Request for the TestWebhook method
func NewUpdateFolderRequest ¶
func NewUpdateFolderRequest(server string, mailboxResourceId string, folder string, body UpdateFolderJSONRequestBody) (*http.Request, error)
NewUpdateFolderRequest calls the generic UpdateFolder builder with application/json body
func NewUpdateFolderRequestWithBody ¶
func NewUpdateFolderRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateFolderRequestWithBody constructs an http.Request for the UpdateFolder method, with any body, and a specified content type
func NewUpdateMessageFlagsRequest ¶
func NewUpdateMessageFlagsRequest(server string, mailboxResourceId string, folder string, body UpdateMessageFlagsJSONRequestBody) (*http.Request, error)
NewUpdateMessageFlagsRequest calls the generic UpdateMessageFlags builder with application/json body
func NewUpdateMessageFlagsRequestWithBody ¶
func NewUpdateMessageFlagsRequestWithBody(server string, mailboxResourceId string, folder string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateMessageFlagsRequestWithBody constructs an http.Request for the UpdateMessageFlags method, with any body, and a specified content type
func NewUpdateWebhookRequest ¶
func NewUpdateWebhookRequest(server string, mailboxResourceId string, webhook openapi_types.UUID, body UpdateWebhookJSONRequestBody) (*http.Request, error)
NewUpdateWebhookRequest calls the generic UpdateWebhook builder with application/json body
func NewUpdateWebhookRequestWithBody ¶
func NewUpdateWebhookRequestWithBody(server string, mailboxResourceId string, webhook openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)
NewUpdateWebhookRequestWithBody constructs an http.Request for the UpdateWebhook method, with any body, and a specified content type
Types ¶
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) CreateFolder ¶
func (c *Client) CreateFolder(ctx context.Context, mailboxResourceId string, body CreateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateFolder Create folder
Create a new folder in the managed mailbox.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
func (*Client) CreateFolderWithBody ¶
func (c *Client) CreateFolderWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateFolderWithBody Create folder
Create a new folder in the managed mailbox.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
func (*Client) CreateWebhook ¶
func (c *Client) CreateWebhook(ctx context.Context, mailboxResourceId string, body CreateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateWebhook Create webhook
Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
func (*Client) CreateWebhookWithBody ¶
func (c *Client) CreateWebhookWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateWebhookWithBody Create webhook
Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
func (*Client) DeleteAllMessages ¶
func (c *Client) DeleteAllMessages(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteAllMessages Delete all messages
Permanently delete every message in a folder (empty the folder).
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `DeleteAllMessages` operationId).
func (*Client) DeleteFolder ¶
func (c *Client) DeleteFolder(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteFolder Delete folder
Delete a folder and all of its subfolders.
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `DeleteFolder` operationId).
func (*Client) DeleteMessage ¶
func (c *Client) DeleteMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteMessage Delete message
Permanently delete a single message.
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `DeleteMessage` operationId).
func (*Client) DeleteMessages ¶
func (c *Client) DeleteMessages(ctx context.Context, mailboxResourceId string, folder string, body DeleteMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteMessages Delete messages
Permanently delete multiple messages from a folder.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
func (*Client) DeleteMessagesWithBody ¶
func (c *Client) DeleteMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteMessagesWithBody Delete messages
Permanently delete multiple messages from a folder.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
func (*Client) DeleteWebhook ¶
func (c *Client) DeleteWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteWebhook Delete webhook
Delete a webhook.
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `DeleteWebhook` operationId).
func (*Client) GetCurrentAccount ¶
func (c *Client) GetCurrentAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetCurrentAccount Get the authenticated account
Returns the authenticated account and the mailboxes it can manage.
Corresponds with GET /api/v1/me (the `GetCurrentAccount` operationId).
func (*Client) GetMessage ¶
func (c *Client) GetMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMessage Get message
Retrieve a single message by UID.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `GetMessage` operationId).
func (*Client) GetMessageAttachment ¶
func (c *Client) GetMessageAttachment(ctx context.Context, mailboxResourceId string, folder string, uid int, attachmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMessageAttachment Download message attachment
Download a message attachment as `application/octet-stream`.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} (the `GetMessageAttachment` operationId).
func (*Client) GetMessageSource ¶
func (c *Client) GetMessageSource(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMessageSource Get message source
Retrieve raw RFC822 source of a message as `message/rfc822` attachment.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source (the `GetMessageSource` operationId).
func (*Client) GetMessageText ¶
func (c *Client) GetMessageText(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMessageText Get message text content
Retrieve rendered text (plain + HTML) of a message. Marks message as `\Seen`.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text (the `GetMessageText` operationId).
func (*Client) GetQuota ¶
func (c *Client) GetQuota(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*http.Response, error)
GetQuota Get mailbox quota
Retrieve storage and message quota usage for the managed mailbox.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/quota (the `GetQuota` operationId).
func (*Client) GetWebhook ¶
func (c *Client) GetWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetWebhook Get webhook
Retrieve a single webhook by id.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `GetWebhook` operationId).
func (*Client) ListFolders ¶
func (c *Client) ListFolders(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListFolders List folders
Retrieve a paginated list of folders in the managed mailbox.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders (the `ListFolders` operationId).
func (*Client) ListMessages ¶
func (c *Client) ListMessages(ctx context.Context, mailboxResourceId string, folder string, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListMessages List messages
List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `ListMessages` operationId).
func (*Client) ListWebhooks ¶
func (c *Client) ListWebhooks(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListWebhooks List webhooks
List webhooks for a mailbox.
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `ListWebhooks` operationId).
func (*Client) MoveMessage ¶
func (c *Client) MoveMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, body MoveMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
MoveMessage Move message
Move a single message to a target folder.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
func (*Client) MoveMessageWithBody ¶
func (c *Client) MoveMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
MoveMessageWithBody Move message
Move a single message to a target folder.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
func (*Client) MoveMessages ¶
func (c *Client) MoveMessages(ctx context.Context, mailboxResourceId string, folder string, body MoveMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
MoveMessages Move messages
Move multiple messages from a source folder to a target folder.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
func (*Client) MoveMessagesWithBody ¶
func (c *Client) MoveMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
MoveMessagesWithBody Move messages
Move multiple messages from a source folder to a target folder.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
func (*Client) PatchMessage ¶
func (c *Client) PatchMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, body PatchMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchMessage Update message flags
Add and/or remove flags on a single message. Returns the updated message.
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
func (*Client) PatchMessageWithBody ¶
func (c *Client) PatchMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchMessageWithBody Update message flags
Add and/or remove flags on a single message. Returns the updated message.
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
func (*Client) RegenerateWebhookSecret ¶
func (c *Client) RegenerateWebhookSecret(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
RegenerateWebhookSecret Regenerate webhook secret
Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret (the `RegenerateWebhookSecret` operationId).
func (*Client) SearchMessages ¶
func (c *Client) SearchMessages(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, body SearchMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
SearchMessages Search messages
Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
func (*Client) SearchMessagesWithBody ¶
func (c *Client) SearchMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SearchMessagesWithBody Search messages
Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
func (*Client) SendEmail ¶
func (c *Client) SendEmail(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
SendEmail Send email
Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
func (*Client) SendEmailWithBody ¶
func (c *Client) SendEmailWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SendEmailWithBody Send email
Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
func (*Client) TestWebhook ¶
func (c *Client) TestWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
TestWebhook Test webhook
Send a test delivery to the webhook URL and return the upstream response.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test (the `TestWebhook` operationId).
func (*Client) UpdateFolder ¶
func (c *Client) UpdateFolder(ctx context.Context, mailboxResourceId string, folder string, body UpdateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateFolder Update folder
Rename an existing folder.
Takes a body of the `application/json` content type.
Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
func (*Client) UpdateFolderWithBody ¶
func (c *Client) UpdateFolderWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateFolderWithBody Update folder
Rename an existing folder.
Takes any type of body and a specified content type.
Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
func (*Client) UpdateMessageFlags ¶
func (c *Client) UpdateMessageFlags(ctx context.Context, mailboxResourceId string, folder string, body UpdateMessageFlagsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateMessageFlags Update message flags
Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
func (*Client) UpdateMessageFlagsWithBody ¶
func (c *Client) UpdateMessageFlagsWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateMessageFlagsWithBody Update message flags
Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
Takes any type of body and a specified content type.
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
func (*Client) UpdateWebhook ¶
func (c *Client) UpdateWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, body UpdateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateWebhook Update webhook
Partially update a webhook.
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
func (*Client) UpdateWebhookWithBody ¶
func (c *Client) UpdateWebhookWithBody(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateWebhookWithBody Update webhook
Partially update a webhook.
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
type ClientInterface ¶
type ClientInterface interface {
// ListFolders List folders
//
// Retrieve a paginated list of folders in the managed mailbox.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders (the `ListFolders` operationId).
ListFolders(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateFolderWithBody Create folder
//
// Create a new folder in the managed mailbox.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
CreateFolderWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateFolder Create folder
//
// Create a new folder in the managed mailbox.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
CreateFolder(ctx context.Context, mailboxResourceId string, body CreateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteFolder Delete folder
//
// Delete a folder and all of its subfolders.
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `DeleteFolder` operationId).
DeleteFolder(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateFolderWithBody Update folder
//
// Rename an existing folder.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
UpdateFolderWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateFolder Update folder
//
// Rename an existing folder.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
UpdateFolder(ctx context.Context, mailboxResourceId string, folder string, body UpdateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteAllMessages Delete all messages
//
// Permanently delete every message in a folder (empty the folder).
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `DeleteAllMessages` operationId).
DeleteAllMessages(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListMessages List messages
//
// List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `ListMessages` operationId).
ListMessages(ctx context.Context, mailboxResourceId string, folder string, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteMessagesWithBody Delete messages
//
// Permanently delete multiple messages from a folder.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
DeleteMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteMessages Delete messages
//
// Permanently delete multiple messages from a folder.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
DeleteMessages(ctx context.Context, mailboxResourceId string, folder string, body DeleteMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateMessageFlagsWithBody Update message flags
//
// Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
UpdateMessageFlagsWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateMessageFlags Update message flags
//
// Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
UpdateMessageFlags(ctx context.Context, mailboxResourceId string, folder string, body UpdateMessageFlagsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// MoveMessagesWithBody Move messages
//
// Move multiple messages from a source folder to a target folder.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
MoveMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// MoveMessages Move messages
//
// Move multiple messages from a source folder to a target folder.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
MoveMessages(ctx context.Context, mailboxResourceId string, folder string, body MoveMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SearchMessagesWithBody Search messages
//
// Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
SearchMessagesWithBody(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// SearchMessages Search messages
//
// Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
SearchMessages(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, body SearchMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteMessage Delete message
//
// Permanently delete a single message.
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `DeleteMessage` operationId).
DeleteMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMessage Get message
//
// Retrieve a single message by UID.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `GetMessage` operationId).
GetMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchMessageWithBody Update message flags
//
// Add and/or remove flags on a single message. Returns the updated message.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
PatchMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchMessage Update message flags
//
// Add and/or remove flags on a single message. Returns the updated message.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
PatchMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, body PatchMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMessageAttachment Download message attachment
//
// Download a message attachment as `application/octet-stream`.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} (the `GetMessageAttachment` operationId).
GetMessageAttachment(ctx context.Context, mailboxResourceId string, folder string, uid int, attachmentId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// MoveMessageWithBody Move message
//
// Move a single message to a target folder.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
MoveMessageWithBody(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// MoveMessage Move message
//
// Move a single message to a target folder.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
MoveMessage(ctx context.Context, mailboxResourceId string, folder string, uid int, body MoveMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMessageSource Get message source
//
// Retrieve raw RFC822 source of a message as `message/rfc822` attachment.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source (the `GetMessageSource` operationId).
GetMessageSource(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMessageText Get message text content
//
// Retrieve rendered text (plain + HTML) of a message. Marks message as `\Seen`.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text (the `GetMessageText` operationId).
GetMessageText(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetQuota Get mailbox quota
//
// Retrieve storage and message quota usage for the managed mailbox.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/quota (the `GetQuota` operationId).
GetQuota(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SendEmailWithBody Send email
//
// Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
SendEmailWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// SendEmail Send email
//
// Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
SendEmail(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListWebhooks List webhooks
//
// List webhooks for a mailbox.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `ListWebhooks` operationId).
ListWebhooks(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateWebhookWithBody Create webhook
//
// Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
CreateWebhookWithBody(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateWebhook Create webhook
//
// Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
CreateWebhook(ctx context.Context, mailboxResourceId string, body CreateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteWebhook Delete webhook
//
// Delete a webhook.
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `DeleteWebhook` operationId).
DeleteWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetWebhook Get webhook
//
// Retrieve a single webhook by id.
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `GetWebhook` operationId).
GetWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateWebhookWithBody Update webhook
//
// Partially update a webhook.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
UpdateWebhookWithBody(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateWebhook Update webhook
//
// Partially update a webhook.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
UpdateWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, body UpdateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegenerateWebhookSecret Regenerate webhook secret
//
// Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret (the `RegenerateWebhookSecret` operationId).
RegenerateWebhookSecret(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// TestWebhook Test webhook
//
// Send a test delivery to the webhook URL and return the upstream response.
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test (the `TestWebhook` operationId).
TestWebhook(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetCurrentAccount Get the authenticated account
//
// Returns the authenticated account and the mailboxes it can manage.
//
// Corresponds with GET /api/v1/me (the `GetCurrentAccount` operationId).
GetCurrentAccount(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CreateFolderWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFolderResponse, error)
CreateFolderWithBodyWithResponse Create folder
Create a new folder in the managed mailbox.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
func (*ClientWithResponses) CreateFolderWithResponse ¶
func (c *ClientWithResponses) CreateFolderWithResponse(ctx context.Context, mailboxResourceId string, body CreateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFolderResponse, error)
CreateFolderWithResponse Create folder
Create a new folder in the managed mailbox.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
func (*ClientWithResponses) CreateWebhookWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWebhookResponse, error)
CreateWebhookWithBodyWithResponse Create webhook
Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
func (*ClientWithResponses) CreateWebhookWithResponse ¶
func (c *ClientWithResponses) CreateWebhookWithResponse(ctx context.Context, mailboxResourceId string, body CreateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWebhookResponse, error)
CreateWebhookWithResponse Create webhook
Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
func (*ClientWithResponses) DeleteAllMessagesWithResponse ¶
func (c *ClientWithResponses) DeleteAllMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*DeleteAllMessagesResponse, error)
DeleteAllMessagesWithResponse Delete all messages
Permanently delete every message in a folder (empty the folder).
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `DeleteAllMessages` operationId).
func (*ClientWithResponses) DeleteFolderWithResponse ¶
func (c *ClientWithResponses) DeleteFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*DeleteFolderResponse, error)
DeleteFolderWithResponse Delete folder
Delete a folder and all of its subfolders.
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `DeleteFolder` operationId).
func (*ClientWithResponses) DeleteMessageWithResponse ¶
func (c *ClientWithResponses) DeleteMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*DeleteMessageResponse, error)
DeleteMessageWithResponse Delete message
Permanently delete a single message.
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `DeleteMessage` operationId).
func (*ClientWithResponses) DeleteMessagesWithBodyWithResponse ¶
func (c *ClientWithResponses) DeleteMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteMessagesResponse, error)
DeleteMessagesWithBodyWithResponse Delete messages
Permanently delete multiple messages from a folder.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
func (*ClientWithResponses) DeleteMessagesWithResponse ¶
func (c *ClientWithResponses) DeleteMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, body DeleteMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteMessagesResponse, error)
DeleteMessagesWithResponse Delete messages
Permanently delete multiple messages from a folder.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
func (*ClientWithResponses) DeleteWebhookWithResponse ¶
func (c *ClientWithResponses) DeleteWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteWebhookResponse, error)
DeleteWebhookWithResponse Delete webhook
Delete a webhook.
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `DeleteWebhook` operationId).
func (*ClientWithResponses) GetCurrentAccountWithResponse ¶
func (c *ClientWithResponses) GetCurrentAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCurrentAccountResponse, error)
GetCurrentAccountWithResponse Get the authenticated account
Returns the authenticated account and the mailboxes it can manage.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/me (the `GetCurrentAccount` operationId).
func (*ClientWithResponses) GetMessageAttachmentWithResponse ¶
func (c *ClientWithResponses) GetMessageAttachmentWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, attachmentId string, reqEditors ...RequestEditorFn) (*GetMessageAttachmentResponse, error)
GetMessageAttachmentWithResponse Download message attachment
Download a message attachment as `application/octet-stream`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} (the `GetMessageAttachment` operationId).
func (*ClientWithResponses) GetMessageSourceWithResponse ¶
func (c *ClientWithResponses) GetMessageSourceWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageSourceResponse, error)
GetMessageSourceWithResponse Get message source
Retrieve raw RFC822 source of a message as `message/rfc822` attachment.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source (the `GetMessageSource` operationId).
func (*ClientWithResponses) GetMessageTextWithResponse ¶
func (c *ClientWithResponses) GetMessageTextWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageTextResponse, error)
GetMessageTextWithResponse Get message text content
Retrieve rendered text (plain + HTML) of a message. Marks message as `\Seen`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text (the `GetMessageText` operationId).
func (*ClientWithResponses) GetMessageWithResponse ¶
func (c *ClientWithResponses) GetMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageResponse, error)
GetMessageWithResponse Get message
Retrieve a single message by UID.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `GetMessage` operationId).
func (*ClientWithResponses) GetQuotaWithResponse ¶
func (c *ClientWithResponses) GetQuotaWithResponse(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*GetQuotaResponse, error)
GetQuotaWithResponse Get mailbox quota
Retrieve storage and message quota usage for the managed mailbox.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/quota (the `GetQuota` operationId).
func (*ClientWithResponses) GetWebhookWithResponse ¶
func (c *ClientWithResponses) GetWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetWebhookResponse, error)
GetWebhookWithResponse Get webhook
Retrieve a single webhook by id.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `GetWebhook` operationId).
func (*ClientWithResponses) ListFoldersWithResponse ¶
func (c *ClientWithResponses) ListFoldersWithResponse(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, reqEditors ...RequestEditorFn) (*ListFoldersResponse, error)
ListFoldersWithResponse List folders
Retrieve a paginated list of folders in the managed mailbox.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders (the `ListFolders` operationId).
func (*ClientWithResponses) ListMessagesWithResponse ¶
func (c *ClientWithResponses) ListMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)
ListMessagesWithResponse List messages
List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `ListMessages` operationId).
func (*ClientWithResponses) ListWebhooksWithResponse ¶
func (c *ClientWithResponses) ListWebhooksWithResponse(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, reqEditors ...RequestEditorFn) (*ListWebhooksResponse, error)
ListWebhooksWithResponse List webhooks
List webhooks for a mailbox.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `ListWebhooks` operationId).
func (*ClientWithResponses) MoveMessageWithBodyWithResponse ¶
func (c *ClientWithResponses) MoveMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MoveMessageResponse, error)
MoveMessageWithBodyWithResponse Move message
Move a single message to a target folder.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
func (*ClientWithResponses) MoveMessageWithResponse ¶
func (c *ClientWithResponses) MoveMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, body MoveMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*MoveMessageResponse, error)
MoveMessageWithResponse Move message
Move a single message to a target folder.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
func (*ClientWithResponses) MoveMessagesWithBodyWithResponse ¶
func (c *ClientWithResponses) MoveMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MoveMessagesResponse, error)
MoveMessagesWithBodyWithResponse Move messages
Move multiple messages from a source folder to a target folder.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
func (*ClientWithResponses) MoveMessagesWithResponse ¶
func (c *ClientWithResponses) MoveMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, body MoveMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*MoveMessagesResponse, error)
MoveMessagesWithResponse Move messages
Move multiple messages from a source folder to a target folder.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
func (*ClientWithResponses) PatchMessageWithBodyWithResponse ¶
func (c *ClientWithResponses) PatchMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchMessageResponse, error)
PatchMessageWithBodyWithResponse Update message flags
Add and/or remove flags on a single message. Returns the updated message.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
func (*ClientWithResponses) PatchMessageWithResponse ¶
func (c *ClientWithResponses) PatchMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, body PatchMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchMessageResponse, error)
PatchMessageWithResponse Update message flags
Add and/or remove flags on a single message. Returns the updated message.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
func (*ClientWithResponses) RegenerateWebhookSecretWithResponse ¶
func (c *ClientWithResponses) RegenerateWebhookSecretWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*RegenerateWebhookSecretResponse, error)
RegenerateWebhookSecretWithResponse Regenerate webhook secret
Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once.
Returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret (the `RegenerateWebhookSecret` operationId).
func (*ClientWithResponses) SearchMessagesWithBodyWithResponse ¶
func (c *ClientWithResponses) SearchMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchMessagesResponse, error)
SearchMessagesWithBodyWithResponse Search messages
Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
func (*ClientWithResponses) SearchMessagesWithResponse ¶
func (c *ClientWithResponses) SearchMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, body SearchMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchMessagesResponse, error)
SearchMessagesWithResponse Search messages
Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
func (*ClientWithResponses) SendEmailWithBodyWithResponse ¶
func (c *ClientWithResponses) SendEmailWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendEmailResponse, error)
SendEmailWithBodyWithResponse Send email
Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
func (*ClientWithResponses) SendEmailWithResponse ¶
func (c *ClientWithResponses) SendEmailWithResponse(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*SendEmailResponse, error)
SendEmailWithResponse Send email
Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
func (*ClientWithResponses) TestWebhookWithResponse ¶
func (c *ClientWithResponses) TestWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*TestWebhookResponse, error)
TestWebhookWithResponse Test webhook
Send a test delivery to the webhook URL and return the upstream response.
Returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test (the `TestWebhook` operationId).
func (*ClientWithResponses) UpdateFolderWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFolderResponse, error)
UpdateFolderWithBodyWithResponse Update folder
Rename an existing folder.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
func (*ClientWithResponses) UpdateFolderWithResponse ¶
func (c *ClientWithResponses) UpdateFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, body UpdateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFolderResponse, error)
UpdateFolderWithResponse Update folder
Rename an existing folder.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
func (*ClientWithResponses) UpdateMessageFlagsWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateMessageFlagsWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateMessageFlagsResponse, error)
UpdateMessageFlagsWithBodyWithResponse Update message flags
Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
func (*ClientWithResponses) UpdateMessageFlagsWithResponse ¶
func (c *ClientWithResponses) UpdateMessageFlagsWithResponse(ctx context.Context, mailboxResourceId string, folder string, body UpdateMessageFlagsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateMessageFlagsResponse, error)
UpdateMessageFlagsWithResponse Update message flags
Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
func (*ClientWithResponses) UpdateWebhookWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWebhookResponse, error)
UpdateWebhookWithBodyWithResponse Update webhook
Partially update a webhook.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
func (*ClientWithResponses) UpdateWebhookWithResponse ¶
func (c *ClientWithResponses) UpdateWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, body UpdateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWebhookResponse, error)
UpdateWebhookWithResponse Update webhook
Partially update a webhook.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ListFoldersWithResponse List folders
//
// Retrieve a paginated list of folders in the managed mailbox.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders (the `ListFolders` operationId).
ListFoldersWithResponse(ctx context.Context, mailboxResourceId string, params *ListFoldersParams, reqEditors ...RequestEditorFn) (*ListFoldersResponse, error)
// CreateFolderWithBodyWithResponse Create folder
//
// Create a new folder in the managed mailbox.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
CreateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFolderResponse, error)
// CreateFolderWithResponse Create folder
//
// Create a new folder in the managed mailbox.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders (the `CreateFolder` operationId).
CreateFolderWithResponse(ctx context.Context, mailboxResourceId string, body CreateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFolderResponse, error)
// DeleteFolderWithResponse Delete folder
//
// Delete a folder and all of its subfolders.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `DeleteFolder` operationId).
DeleteFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*DeleteFolderResponse, error)
// UpdateFolderWithBodyWithResponse Update folder
//
// Rename an existing folder.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
UpdateFolderWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFolderResponse, error)
// UpdateFolderWithResponse Update folder
//
// Rename an existing folder.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /api/v1/mailboxes/{mailboxResourceId}/folders/{folder} (the `UpdateFolder` operationId).
UpdateFolderWithResponse(ctx context.Context, mailboxResourceId string, folder string, body UpdateFolderJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFolderResponse, error)
// DeleteAllMessagesWithResponse Delete all messages
//
// Permanently delete every message in a folder (empty the folder).
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `DeleteAllMessages` operationId).
DeleteAllMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, reqEditors ...RequestEditorFn) (*DeleteAllMessagesResponse, error)
// ListMessagesWithResponse List messages
//
// List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages (the `ListMessages` operationId).
ListMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)
// DeleteMessagesWithBodyWithResponse Delete messages
//
// Permanently delete multiple messages from a folder.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
DeleteMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteMessagesResponse, error)
// DeleteMessagesWithResponse Delete messages
//
// Permanently delete multiple messages from a folder.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/delete (the `DeleteMessages` operationId).
DeleteMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, body DeleteMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteMessagesResponse, error)
// UpdateMessageFlagsWithBodyWithResponse Update message flags
//
// Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
UpdateMessageFlagsWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateMessageFlagsResponse, error)
// UpdateMessageFlagsWithResponse Update message flags
//
// Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/flags (the `UpdateMessageFlags` operationId).
UpdateMessageFlagsWithResponse(ctx context.Context, mailboxResourceId string, folder string, body UpdateMessageFlagsJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateMessageFlagsResponse, error)
// MoveMessagesWithBodyWithResponse Move messages
//
// Move multiple messages from a source folder to a target folder.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
MoveMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MoveMessagesResponse, error)
// MoveMessagesWithResponse Move messages
//
// Move multiple messages from a source folder to a target folder.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/move (the `MoveMessages` operationId).
MoveMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, body MoveMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*MoveMessagesResponse, error)
// SearchMessagesWithBodyWithResponse Search messages
//
// Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
SearchMessagesWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SearchMessagesResponse, error)
// SearchMessagesWithResponse Search messages
//
// Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`).
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/search (the `SearchMessages` operationId).
SearchMessagesWithResponse(ctx context.Context, mailboxResourceId string, folder string, params *SearchMessagesParams, body SearchMessagesJSONRequestBody, reqEditors ...RequestEditorFn) (*SearchMessagesResponse, error)
// DeleteMessageWithResponse Delete message
//
// Permanently delete a single message.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `DeleteMessage` operationId).
DeleteMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*DeleteMessageResponse, error)
// GetMessageWithResponse Get message
//
// Retrieve a single message by UID.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `GetMessage` operationId).
GetMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageResponse, error)
// PatchMessageWithBodyWithResponse Update message flags
//
// Add and/or remove flags on a single message. Returns the updated message.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
PatchMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchMessageResponse, error)
// PatchMessageWithResponse Update message flags
//
// Add and/or remove flags on a single message. Returns the updated message.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid} (the `PatchMessage` operationId).
PatchMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, body PatchMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchMessageResponse, error)
// GetMessageAttachmentWithResponse Download message attachment
//
// Download a message attachment as `application/octet-stream`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/attachments/{attachmentId} (the `GetMessageAttachment` operationId).
GetMessageAttachmentWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, attachmentId string, reqEditors ...RequestEditorFn) (*GetMessageAttachmentResponse, error)
// MoveMessageWithBodyWithResponse Move message
//
// Move a single message to a target folder.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
MoveMessageWithBodyWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*MoveMessageResponse, error)
// MoveMessageWithResponse Move message
//
// Move a single message to a target folder.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/move (the `MoveMessage` operationId).
MoveMessageWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, body MoveMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*MoveMessageResponse, error)
// GetMessageSourceWithResponse Get message source
//
// Retrieve raw RFC822 source of a message as `message/rfc822` attachment.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/source (the `GetMessageSource` operationId).
GetMessageSourceWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageSourceResponse, error)
// GetMessageTextWithResponse Get message text content
//
// Retrieve rendered text (plain + HTML) of a message. Marks message as `\Seen`.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/folders/{folder}/messages/{uid}/text (the `GetMessageText` operationId).
GetMessageTextWithResponse(ctx context.Context, mailboxResourceId string, folder string, uid int, reqEditors ...RequestEditorFn) (*GetMessageTextResponse, error)
// GetQuotaWithResponse Get mailbox quota
//
// Retrieve storage and message quota usage for the managed mailbox.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/quota (the `GetQuota` operationId).
GetQuotaWithResponse(ctx context.Context, mailboxResourceId string, reqEditors ...RequestEditorFn) (*GetQuotaResponse, error)
// SendEmailWithBodyWithResponse Send email
//
// Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
SendEmailWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendEmailResponse, error)
// SendEmailWithResponse Send email
//
// Send a message from the managed mailbox. Saves a copy to INBOX.Sent.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/send (the `SendEmail` operationId).
SendEmailWithResponse(ctx context.Context, mailboxResourceId string, body SendEmailJSONRequestBody, reqEditors ...RequestEditorFn) (*SendEmailResponse, error)
// ListWebhooksWithResponse List webhooks
//
// List webhooks for a mailbox.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `ListWebhooks` operationId).
ListWebhooksWithResponse(ctx context.Context, mailboxResourceId string, params *ListWebhooksParams, reqEditors ...RequestEditorFn) (*ListWebhooksResponse, error)
// CreateWebhookWithBodyWithResponse Create webhook
//
// Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
CreateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWebhookResponse, error)
// CreateWebhookWithResponse Create webhook
//
// Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks (the `CreateWebhook` operationId).
CreateWebhookWithResponse(ctx context.Context, mailboxResourceId string, body CreateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWebhookResponse, error)
// DeleteWebhookWithResponse Delete webhook
//
// Delete a webhook.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `DeleteWebhook` operationId).
DeleteWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteWebhookResponse, error)
// GetWebhookWithResponse Get webhook
//
// Retrieve a single webhook by id.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `GetWebhook` operationId).
GetWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetWebhookResponse, error)
// UpdateWebhookWithBodyWithResponse Update webhook
//
// Partially update a webhook.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
UpdateWebhookWithBodyWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWebhookResponse, error)
// UpdateWebhookWithResponse Update webhook
//
// Partially update a webhook.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook} (the `UpdateWebhook` operationId).
UpdateWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, body UpdateWebhookJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWebhookResponse, error)
// RegenerateWebhookSecretWithResponse Regenerate webhook secret
//
// Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/regenerate-secret (the `RegenerateWebhookSecret` operationId).
RegenerateWebhookSecretWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*RegenerateWebhookSecretResponse, error)
// TestWebhookWithResponse Test webhook
//
// Send a test delivery to the webhook URL and return the upstream response.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v1/mailboxes/{mailboxResourceId}/webhooks/{webhook}/test (the `TestWebhook` operationId).
TestWebhookWithResponse(ctx context.Context, mailboxResourceId string, webhook openapi_types.UUID, reqEditors ...RequestEditorFn) (*TestWebhookResponse, error)
// GetCurrentAccountWithResponse Get the authenticated account
//
// Returns the authenticated account and the mailboxes it can manage.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v1/me (the `GetCurrentAccount` operationId).
GetCurrentAccountWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCurrentAccountResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CommonResponseBadGatewayResponse ¶
type CommonResponseBadGatewayResponse = Error
CommonResponseBadGatewayResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseConflictResponse ¶
type CommonResponseConflictResponse = Error
CommonResponseConflictResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseForbiddenResponse ¶
type CommonResponseForbiddenResponse = Error
CommonResponseForbiddenResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseInternalServerErrorResponse ¶
type CommonResponseInternalServerErrorResponse = Error
CommonResponseInternalServerErrorResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseNotFoundResponse ¶
type CommonResponseNotFoundResponse = Error
CommonResponseNotFoundResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseUnauthorizedResponse ¶
type CommonResponseUnauthorizedResponse = Error
CommonResponseUnauthorizedResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CommonResponseValidationFailedResponse ¶
type CommonResponseValidationFailedResponse = Error
CommonResponseValidationFailedResponse Standard error envelope. Frontend translations key off `code`, never off `error`.
type CreateFolderJSONRequestBody ¶
type CreateFolderJSONRequestBody = V1FoldersCreateRequest
CreateFolderJSONRequestBody defines body for CreateFolder for application/json ContentType.
type CreateFolderResponse ¶
type CreateFolderResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *V1FoldersResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *CommonResponseConflictResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseCreateFolderResponse ¶
func ParseCreateFolderResponse(rsp *http.Response) (*CreateFolderResponse, error)
ParseCreateFolderResponse parses an HTTP response from a CreateFolderWithResponse call
func (CreateFolderResponse) ContentType ¶
func (r CreateFolderResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateFolderResponse) GetBody ¶ added in v1.1.1
func (r CreateFolderResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateFolderResponse) GetJSON201 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON201() *V1FoldersResource
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateFolderResponse) GetJSON401 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateFolderResponse) GetJSON403 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (CreateFolderResponse) GetJSON409 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON409() *CommonResponseConflictResponse
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (CreateFolderResponse) GetJSON422 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (CreateFolderResponse) GetJSON500 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (CreateFolderResponse) GetJSON502 ¶ added in v1.1.1
func (r CreateFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (CreateFolderResponse) Status ¶
func (r CreateFolderResponse) Status() string
Status returns HTTPResponse.Status
func (CreateFolderResponse) StatusCode ¶
func (r CreateFolderResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateWebhookJSONRequestBody ¶
type CreateWebhookJSONRequestBody = V1WebhooksCreateRequest
CreateWebhookJSONRequestBody defines body for CreateWebhook for application/json ContentType.
type CreateWebhookResponse ¶
type CreateWebhookResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *V1WebhooksResourceWithSecret
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseCreateWebhookResponse ¶
func ParseCreateWebhookResponse(rsp *http.Response) (*CreateWebhookResponse, error)
ParseCreateWebhookResponse parses an HTTP response from a CreateWebhookWithResponse call
func (CreateWebhookResponse) ContentType ¶
func (r CreateWebhookResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateWebhookResponse) GetBody ¶ added in v1.1.1
func (r CreateWebhookResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateWebhookResponse) GetJSON201 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON201() *V1WebhooksResourceWithSecret
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateWebhookResponse) GetJSON401 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateWebhookResponse) GetJSON403 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (CreateWebhookResponse) GetJSON422 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (CreateWebhookResponse) GetJSON500 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (CreateWebhookResponse) GetJSON502 ¶ added in v1.1.1
func (r CreateWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (CreateWebhookResponse) Status ¶
func (r CreateWebhookResponse) Status() string
Status returns HTTPResponse.Status
func (CreateWebhookResponse) StatusCode ¶
func (r CreateWebhookResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteAllMessagesResponse ¶
type DeleteAllMessagesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseDeleteAllMessagesResponse ¶
func ParseDeleteAllMessagesResponse(rsp *http.Response) (*DeleteAllMessagesResponse, error)
ParseDeleteAllMessagesResponse parses an HTTP response from a DeleteAllMessagesWithResponse call
func (DeleteAllMessagesResponse) ContentType ¶
func (r DeleteAllMessagesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteAllMessagesResponse) GetBody ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteAllMessagesResponse) GetJSON401 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteAllMessagesResponse) GetJSON403 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (DeleteAllMessagesResponse) GetJSON404 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (DeleteAllMessagesResponse) GetJSON422 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (DeleteAllMessagesResponse) GetJSON500 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (DeleteAllMessagesResponse) GetJSON502 ¶ added in v1.1.1
func (r DeleteAllMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (DeleteAllMessagesResponse) Status ¶
func (r DeleteAllMessagesResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteAllMessagesResponse) StatusCode ¶
func (r DeleteAllMessagesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteFolderResponse ¶
type DeleteFolderResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *CommonResponseConflictResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseDeleteFolderResponse ¶
func ParseDeleteFolderResponse(rsp *http.Response) (*DeleteFolderResponse, error)
ParseDeleteFolderResponse parses an HTTP response from a DeleteFolderWithResponse call
func (DeleteFolderResponse) ContentType ¶
func (r DeleteFolderResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteFolderResponse) GetBody ¶ added in v1.1.1
func (r DeleteFolderResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteFolderResponse) GetJSON401 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteFolderResponse) GetJSON403 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (DeleteFolderResponse) GetJSON404 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (DeleteFolderResponse) GetJSON409 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON409() *CommonResponseConflictResponse
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (DeleteFolderResponse) GetJSON422 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (DeleteFolderResponse) GetJSON500 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (DeleteFolderResponse) GetJSON502 ¶ added in v1.1.1
func (r DeleteFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (DeleteFolderResponse) Status ¶
func (r DeleteFolderResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteFolderResponse) StatusCode ¶
func (r DeleteFolderResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteMessageResponse ¶
type DeleteMessageResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseDeleteMessageResponse ¶
func ParseDeleteMessageResponse(rsp *http.Response) (*DeleteMessageResponse, error)
ParseDeleteMessageResponse parses an HTTP response from a DeleteMessageWithResponse call
func (DeleteMessageResponse) ContentType ¶
func (r DeleteMessageResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteMessageResponse) GetBody ¶ added in v1.1.1
func (r DeleteMessageResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteMessageResponse) GetJSON401 ¶ added in v1.1.1
func (r DeleteMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteMessageResponse) GetJSON403 ¶ added in v1.1.1
func (r DeleteMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (DeleteMessageResponse) GetJSON422 ¶ added in v1.1.1
func (r DeleteMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (DeleteMessageResponse) GetJSON500 ¶ added in v1.1.1
func (r DeleteMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (DeleteMessageResponse) GetJSON502 ¶ added in v1.1.1
func (r DeleteMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (DeleteMessageResponse) Status ¶
func (r DeleteMessageResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteMessageResponse) StatusCode ¶
func (r DeleteMessageResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteMessagesJSONRequestBody ¶
type DeleteMessagesJSONRequestBody = V1FolderMessagesDeleteBulkRequest
DeleteMessagesJSONRequestBody defines body for DeleteMessages for application/json ContentType.
type DeleteMessagesResponse ¶
type DeleteMessagesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseDeleteMessagesResponse ¶
func ParseDeleteMessagesResponse(rsp *http.Response) (*DeleteMessagesResponse, error)
ParseDeleteMessagesResponse parses an HTTP response from a DeleteMessagesWithResponse call
func (DeleteMessagesResponse) ContentType ¶
func (r DeleteMessagesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteMessagesResponse) GetBody ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteMessagesResponse) GetJSON401 ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteMessagesResponse) GetJSON403 ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (DeleteMessagesResponse) GetJSON422 ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (DeleteMessagesResponse) GetJSON500 ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (DeleteMessagesResponse) GetJSON502 ¶ added in v1.1.1
func (r DeleteMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (DeleteMessagesResponse) Status ¶
func (r DeleteMessagesResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteMessagesResponse) StatusCode ¶
func (r DeleteMessagesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteWebhookResponse ¶
type DeleteWebhookResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseDeleteWebhookResponse ¶
func ParseDeleteWebhookResponse(rsp *http.Response) (*DeleteWebhookResponse, error)
ParseDeleteWebhookResponse parses an HTTP response from a DeleteWebhookWithResponse call
func (DeleteWebhookResponse) ContentType ¶
func (r DeleteWebhookResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteWebhookResponse) GetBody ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteWebhookResponse) GetJSON401 ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteWebhookResponse) GetJSON403 ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (DeleteWebhookResponse) GetJSON404 ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (DeleteWebhookResponse) GetJSON500 ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (DeleteWebhookResponse) GetJSON502 ¶ added in v1.1.1
func (r DeleteWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (DeleteWebhookResponse) Status ¶
func (r DeleteWebhookResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteWebhookResponse) StatusCode ¶
func (r DeleteWebhookResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Error ¶
type Error struct {
// Code Machine-readable error code in SCREAMING_SNAKE_CASE.
//
// Example: ERR_RESOURCE_NOT_FOUND
Code string `json:"code"`
// Error Human-readable error message.
//
// Example: Resource not found.
Error string `json:"error"`
// Params Additional structured context for the error. May be omitted.
Params *map[string]interface{} `json:"params,omitempty"`
}
Error Standard error envelope. Frontend translations key off `code`, never off `error`.
type GetCurrentAccountResponse ¶
type GetCurrentAccountResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1MeResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetCurrentAccountResponse ¶
func ParseGetCurrentAccountResponse(rsp *http.Response) (*GetCurrentAccountResponse, error)
ParseGetCurrentAccountResponse parses an HTTP response from a GetCurrentAccountWithResponse call
func (GetCurrentAccountResponse) ContentType ¶
func (r GetCurrentAccountResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetCurrentAccountResponse) GetBody ¶ added in v1.1.1
func (r GetCurrentAccountResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetCurrentAccountResponse) GetJSON200 ¶ added in v1.1.1
func (r GetCurrentAccountResponse) GetJSON200() *V1MeResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetCurrentAccountResponse) GetJSON401 ¶ added in v1.1.1
func (r GetCurrentAccountResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetCurrentAccountResponse) GetJSON500 ¶ added in v1.1.1
func (r GetCurrentAccountResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetCurrentAccountResponse) GetJSON502 ¶ added in v1.1.1
func (r GetCurrentAccountResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetCurrentAccountResponse) Status ¶
func (r GetCurrentAccountResponse) Status() string
Status returns HTTPResponse.Status
func (GetCurrentAccountResponse) StatusCode ¶
func (r GetCurrentAccountResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMessageAttachmentResponse ¶
type GetMessageAttachmentResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetMessageAttachmentResponse ¶
func ParseGetMessageAttachmentResponse(rsp *http.Response) (*GetMessageAttachmentResponse, error)
ParseGetMessageAttachmentResponse parses an HTTP response from a GetMessageAttachmentWithResponse call
func (GetMessageAttachmentResponse) ContentType ¶
func (r GetMessageAttachmentResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMessageAttachmentResponse) GetBody ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMessageAttachmentResponse) GetJSON401 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetMessageAttachmentResponse) GetJSON403 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetMessageAttachmentResponse) GetJSON404 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetMessageAttachmentResponse) GetJSON422 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (GetMessageAttachmentResponse) GetJSON500 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetMessageAttachmentResponse) GetJSON502 ¶ added in v1.1.1
func (r GetMessageAttachmentResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetMessageAttachmentResponse) Status ¶
func (r GetMessageAttachmentResponse) Status() string
Status returns HTTPResponse.Status
func (GetMessageAttachmentResponse) StatusCode ¶
func (r GetMessageAttachmentResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMessageResponse ¶
type GetMessageResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetMessageResponse ¶
func ParseGetMessageResponse(rsp *http.Response) (*GetMessageResponse, error)
ParseGetMessageResponse parses an HTTP response from a GetMessageWithResponse call
func (GetMessageResponse) ContentType ¶
func (r GetMessageResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMessageResponse) GetBody ¶ added in v1.1.1
func (r GetMessageResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMessageResponse) GetJSON200 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON200() *V1FolderMessagesResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetMessageResponse) GetJSON401 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetMessageResponse) GetJSON403 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetMessageResponse) GetJSON404 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetMessageResponse) GetJSON422 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (GetMessageResponse) GetJSON500 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetMessageResponse) GetJSON502 ¶ added in v1.1.1
func (r GetMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetMessageResponse) Status ¶
func (r GetMessageResponse) Status() string
Status returns HTTPResponse.Status
func (GetMessageResponse) StatusCode ¶
func (r GetMessageResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMessageSourceResponse ¶
type GetMessageSourceResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetMessageSourceResponse ¶
func ParseGetMessageSourceResponse(rsp *http.Response) (*GetMessageSourceResponse, error)
ParseGetMessageSourceResponse parses an HTTP response from a GetMessageSourceWithResponse call
func (GetMessageSourceResponse) ContentType ¶
func (r GetMessageSourceResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMessageSourceResponse) GetBody ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMessageSourceResponse) GetJSON401 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetMessageSourceResponse) GetJSON403 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetMessageSourceResponse) GetJSON404 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetMessageSourceResponse) GetJSON422 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (GetMessageSourceResponse) GetJSON500 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetMessageSourceResponse) GetJSON502 ¶ added in v1.1.1
func (r GetMessageSourceResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetMessageSourceResponse) Status ¶
func (r GetMessageSourceResponse) Status() string
Status returns HTTPResponse.Status
func (GetMessageSourceResponse) StatusCode ¶
func (r GetMessageSourceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMessageTextResponse ¶
type GetMessageTextResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesMessageTextResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetMessageTextResponse ¶
func ParseGetMessageTextResponse(rsp *http.Response) (*GetMessageTextResponse, error)
ParseGetMessageTextResponse parses an HTTP response from a GetMessageTextWithResponse call
func (GetMessageTextResponse) ContentType ¶
func (r GetMessageTextResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMessageTextResponse) GetBody ¶ added in v1.1.1
func (r GetMessageTextResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMessageTextResponse) GetJSON200 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON200() *V1FolderMessagesMessageTextResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetMessageTextResponse) GetJSON401 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetMessageTextResponse) GetJSON403 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetMessageTextResponse) GetJSON404 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetMessageTextResponse) GetJSON422 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (GetMessageTextResponse) GetJSON500 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetMessageTextResponse) GetJSON502 ¶ added in v1.1.1
func (r GetMessageTextResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetMessageTextResponse) Status ¶
func (r GetMessageTextResponse) Status() string
Status returns HTTPResponse.Status
func (GetMessageTextResponse) StatusCode ¶
func (r GetMessageTextResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetQuotaResponse ¶
type GetQuotaResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1QuotaResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetQuotaResponse ¶
func ParseGetQuotaResponse(rsp *http.Response) (*GetQuotaResponse, error)
ParseGetQuotaResponse parses an HTTP response from a GetQuotaWithResponse call
func (GetQuotaResponse) ContentType ¶
func (r GetQuotaResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetQuotaResponse) GetBody ¶ added in v1.1.1
func (r GetQuotaResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetQuotaResponse) GetJSON200 ¶ added in v1.1.1
func (r GetQuotaResponse) GetJSON200() *V1QuotaResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetQuotaResponse) GetJSON401 ¶ added in v1.1.1
func (r GetQuotaResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetQuotaResponse) GetJSON403 ¶ added in v1.1.1
func (r GetQuotaResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetQuotaResponse) GetJSON500 ¶ added in v1.1.1
func (r GetQuotaResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetQuotaResponse) GetJSON502 ¶ added in v1.1.1
func (r GetQuotaResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetQuotaResponse) Status ¶
func (r GetQuotaResponse) Status() string
Status returns HTTPResponse.Status
func (GetQuotaResponse) StatusCode ¶
func (r GetQuotaResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetWebhookResponse ¶
type GetWebhookResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1WebhooksResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseGetWebhookResponse ¶
func ParseGetWebhookResponse(rsp *http.Response) (*GetWebhookResponse, error)
ParseGetWebhookResponse parses an HTTP response from a GetWebhookWithResponse call
func (GetWebhookResponse) ContentType ¶
func (r GetWebhookResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetWebhookResponse) GetBody ¶ added in v1.1.1
func (r GetWebhookResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetWebhookResponse) GetJSON200 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON200() *V1WebhooksResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetWebhookResponse) GetJSON401 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetWebhookResponse) GetJSON403 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (GetWebhookResponse) GetJSON404 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetWebhookResponse) GetJSON500 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (GetWebhookResponse) GetJSON502 ¶ added in v1.1.1
func (r GetWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (GetWebhookResponse) Status ¶
func (r GetWebhookResponse) Status() string
Status returns HTTPResponse.Status
func (GetWebhookResponse) StatusCode ¶
func (r GetWebhookResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type ListFoldersParams ¶
type ListFoldersParams struct {
// Page Page number (1-based).
Page *int `form:"page,omitempty" json:"page,omitempty"`
// PerPage Items per page (max 100).
PerPage *int `form:"perPage,omitempty" json:"perPage,omitempty"`
}
ListFoldersParams defines parameters for ListFolders.
type ListFoldersResponse ¶
type ListFoldersResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FoldersCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseListFoldersResponse ¶
func ParseListFoldersResponse(rsp *http.Response) (*ListFoldersResponse, error)
ParseListFoldersResponse parses an HTTP response from a ListFoldersWithResponse call
func (ListFoldersResponse) ContentType ¶
func (r ListFoldersResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListFoldersResponse) GetBody ¶ added in v1.1.1
func (r ListFoldersResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListFoldersResponse) GetJSON200 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON200() *V1FoldersCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListFoldersResponse) GetJSON401 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListFoldersResponse) GetJSON403 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (ListFoldersResponse) GetJSON422 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (ListFoldersResponse) GetJSON500 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (ListFoldersResponse) GetJSON502 ¶ added in v1.1.1
func (r ListFoldersResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (ListFoldersResponse) Status ¶
func (r ListFoldersResponse) Status() string
Status returns HTTPResponse.Status
func (ListFoldersResponse) StatusCode ¶
func (r ListFoldersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListMessagesParams ¶
type ListMessagesParams struct {
// Page Page number (1-based).
Page *int `form:"page,omitempty" json:"page,omitempty"`
// PerPage Items per page (max 100).
PerPage *int `form:"perPage,omitempty" json:"perPage,omitempty"`
// Sort Sort field with optional `-` prefix for descending. Allowed: uid, date, size.
Sort *string `form:"sort,omitempty" json:"sort,omitempty"`
}
ListMessagesParams defines parameters for ListMessages.
type ListMessagesResponse ¶
type ListMessagesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseListMessagesResponse ¶
func ParseListMessagesResponse(rsp *http.Response) (*ListMessagesResponse, error)
ParseListMessagesResponse parses an HTTP response from a ListMessagesWithResponse call
func (ListMessagesResponse) ContentType ¶
func (r ListMessagesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListMessagesResponse) GetBody ¶ added in v1.1.1
func (r ListMessagesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListMessagesResponse) GetJSON200 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON200() *V1FolderMessagesCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListMessagesResponse) GetJSON401 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListMessagesResponse) GetJSON403 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (ListMessagesResponse) GetJSON422 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (ListMessagesResponse) GetJSON500 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (ListMessagesResponse) GetJSON502 ¶ added in v1.1.1
func (r ListMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (ListMessagesResponse) Status ¶
func (r ListMessagesResponse) Status() string
Status returns HTTPResponse.Status
func (ListMessagesResponse) StatusCode ¶
func (r ListMessagesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListWebhooksParams ¶
type ListWebhooksParams struct {
Status *ListWebhooksParamsStatus `form:"status,omitempty" json:"status,omitempty"`
Page *int `form:"page,omitempty" json:"page,omitempty"`
PerPage *int `form:"perPage,omitempty" json:"perPage,omitempty"`
}
ListWebhooksParams defines parameters for ListWebhooks.
type ListWebhooksParamsStatus ¶
type ListWebhooksParamsStatus string
ListWebhooksParamsStatus defines parameters for ListWebhooks.
const ( ListWebhooksParamsStatusActive ListWebhooksParamsStatus = "active" ListWebhooksParamsStatusDisabled ListWebhooksParamsStatus = "disabled" ListWebhooksParamsStatusPaused ListWebhooksParamsStatus = "paused" )
Defines values for ListWebhooksParamsStatus.
func (ListWebhooksParamsStatus) Valid ¶
func (e ListWebhooksParamsStatus) Valid() bool
Valid indicates whether the value is a known member of the ListWebhooksParamsStatus enum.
type ListWebhooksResponse ¶
type ListWebhooksResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1WebhooksCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseListWebhooksResponse ¶
func ParseListWebhooksResponse(rsp *http.Response) (*ListWebhooksResponse, error)
ParseListWebhooksResponse parses an HTTP response from a ListWebhooksWithResponse call
func (ListWebhooksResponse) ContentType ¶
func (r ListWebhooksResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListWebhooksResponse) GetBody ¶ added in v1.1.1
func (r ListWebhooksResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListWebhooksResponse) GetJSON200 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON200() *V1WebhooksCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListWebhooksResponse) GetJSON401 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListWebhooksResponse) GetJSON403 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (ListWebhooksResponse) GetJSON422 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (ListWebhooksResponse) GetJSON500 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (ListWebhooksResponse) GetJSON502 ¶ added in v1.1.1
func (r ListWebhooksResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (ListWebhooksResponse) Status ¶
func (r ListWebhooksResponse) Status() string
Status returns HTTPResponse.Status
func (ListWebhooksResponse) StatusCode ¶
func (r ListWebhooksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type MoveMessageJSONRequestBody ¶
type MoveMessageJSONRequestBody = V1FolderMessagesMoveRequest
MoveMessageJSONRequestBody defines body for MoveMessage for application/json ContentType.
type MoveMessageResponse ¶
type MoveMessageResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseMoveMessageResponse ¶
func ParseMoveMessageResponse(rsp *http.Response) (*MoveMessageResponse, error)
ParseMoveMessageResponse parses an HTTP response from a MoveMessageWithResponse call
func (MoveMessageResponse) ContentType ¶
func (r MoveMessageResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (MoveMessageResponse) GetBody ¶ added in v1.1.1
func (r MoveMessageResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (MoveMessageResponse) GetJSON401 ¶ added in v1.1.1
func (r MoveMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (MoveMessageResponse) GetJSON403 ¶ added in v1.1.1
func (r MoveMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (MoveMessageResponse) GetJSON422 ¶ added in v1.1.1
func (r MoveMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (MoveMessageResponse) GetJSON500 ¶ added in v1.1.1
func (r MoveMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (MoveMessageResponse) GetJSON502 ¶ added in v1.1.1
func (r MoveMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (MoveMessageResponse) Status ¶
func (r MoveMessageResponse) Status() string
Status returns HTTPResponse.Status
func (MoveMessageResponse) StatusCode ¶
func (r MoveMessageResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type MoveMessagesJSONRequestBody ¶
type MoveMessagesJSONRequestBody = V1FolderMessagesMoveBulkRequest
MoveMessagesJSONRequestBody defines body for MoveMessages for application/json ContentType.
type MoveMessagesResponse ¶
type MoveMessagesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseMoveMessagesResponse ¶
func ParseMoveMessagesResponse(rsp *http.Response) (*MoveMessagesResponse, error)
ParseMoveMessagesResponse parses an HTTP response from a MoveMessagesWithResponse call
func (MoveMessagesResponse) ContentType ¶
func (r MoveMessagesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (MoveMessagesResponse) GetBody ¶ added in v1.1.1
func (r MoveMessagesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (MoveMessagesResponse) GetJSON401 ¶ added in v1.1.1
func (r MoveMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (MoveMessagesResponse) GetJSON403 ¶ added in v1.1.1
func (r MoveMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (MoveMessagesResponse) GetJSON422 ¶ added in v1.1.1
func (r MoveMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (MoveMessagesResponse) GetJSON500 ¶ added in v1.1.1
func (r MoveMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (MoveMessagesResponse) GetJSON502 ¶ added in v1.1.1
func (r MoveMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (MoveMessagesResponse) Status ¶
func (r MoveMessagesResponse) Status() string
Status returns HTTPResponse.Status
func (MoveMessagesResponse) StatusCode ¶
func (r MoveMessagesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Pagination ¶
type Pagination struct {
// Page Current page number (1-based).
//
// Example: 1
Page int `json:"page"`
// PerPage Items per page.
//
// Example: 25
PerPage int `json:"perPage"`
// Total Total number of items across all pages.
//
// Example: 137
Total int `json:"total"`
// TotalPages Total number of pages.
//
// Example: 6
TotalPages int `json:"totalPages"`
}
Pagination Pagination metadata for paginated collections.
type PatchMessageJSONRequestBody ¶
type PatchMessageJSONRequestBody = V1FolderMessagesFlagsRequest
PatchMessageJSONRequestBody defines body for PatchMessage for application/json ContentType.
type PatchMessageResponse ¶
type PatchMessageResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParsePatchMessageResponse ¶
func ParsePatchMessageResponse(rsp *http.Response) (*PatchMessageResponse, error)
ParsePatchMessageResponse parses an HTTP response from a PatchMessageWithResponse call
func (PatchMessageResponse) ContentType ¶
func (r PatchMessageResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PatchMessageResponse) GetBody ¶ added in v1.1.1
func (r PatchMessageResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PatchMessageResponse) GetJSON200 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON200() *V1FolderMessagesResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PatchMessageResponse) GetJSON401 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (PatchMessageResponse) GetJSON403 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (PatchMessageResponse) GetJSON404 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PatchMessageResponse) GetJSON422 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (PatchMessageResponse) GetJSON500 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (PatchMessageResponse) GetJSON502 ¶ added in v1.1.1
func (r PatchMessageResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (PatchMessageResponse) Status ¶
func (r PatchMessageResponse) Status() string
Status returns HTTPResponse.Status
func (PatchMessageResponse) StatusCode ¶
func (r PatchMessageResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegenerateWebhookSecretResponse ¶
type RegenerateWebhookSecretResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1WebhooksResourceWithSecret
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseRegenerateWebhookSecretResponse ¶
func ParseRegenerateWebhookSecretResponse(rsp *http.Response) (*RegenerateWebhookSecretResponse, error)
ParseRegenerateWebhookSecretResponse parses an HTTP response from a RegenerateWebhookSecretWithResponse call
func (RegenerateWebhookSecretResponse) ContentType ¶
func (r RegenerateWebhookSecretResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (RegenerateWebhookSecretResponse) GetBody ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (RegenerateWebhookSecretResponse) GetJSON200 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON200() *V1WebhooksResourceWithSecret
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (RegenerateWebhookSecretResponse) GetJSON401 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (RegenerateWebhookSecretResponse) GetJSON403 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (RegenerateWebhookSecretResponse) GetJSON404 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (RegenerateWebhookSecretResponse) GetJSON500 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (RegenerateWebhookSecretResponse) GetJSON502 ¶ added in v1.1.1
func (r RegenerateWebhookSecretResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (RegenerateWebhookSecretResponse) Status ¶
func (r RegenerateWebhookSecretResponse) Status() string
Status returns HTTPResponse.Status
func (RegenerateWebhookSecretResponse) StatusCode ¶
func (r RegenerateWebhookSecretResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type SearchMessagesJSONRequestBody ¶
type SearchMessagesJSONRequestBody = V1FolderMessagesSearchRequest
SearchMessagesJSONRequestBody defines body for SearchMessages for application/json ContentType.
type SearchMessagesParams ¶
type SearchMessagesParams struct {
Page *int `form:"page,omitempty" json:"page,omitempty"`
PerPage *int `form:"perPage,omitempty" json:"perPage,omitempty"`
Sort *string `form:"sort,omitempty" json:"sort,omitempty"`
}
SearchMessagesParams defines parameters for SearchMessages.
type SearchMessagesResponse ¶
type SearchMessagesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseSearchMessagesResponse ¶
func ParseSearchMessagesResponse(rsp *http.Response) (*SearchMessagesResponse, error)
ParseSearchMessagesResponse parses an HTTP response from a SearchMessagesWithResponse call
func (SearchMessagesResponse) ContentType ¶
func (r SearchMessagesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (SearchMessagesResponse) GetBody ¶ added in v1.1.1
func (r SearchMessagesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (SearchMessagesResponse) GetJSON200 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON200() *V1FolderMessagesCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (SearchMessagesResponse) GetJSON401 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (SearchMessagesResponse) GetJSON403 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (SearchMessagesResponse) GetJSON422 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (SearchMessagesResponse) GetJSON500 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (SearchMessagesResponse) GetJSON502 ¶ added in v1.1.1
func (r SearchMessagesResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (SearchMessagesResponse) Status ¶
func (r SearchMessagesResponse) Status() string
Status returns HTTPResponse.Status
func (SearchMessagesResponse) StatusCode ¶
func (r SearchMessagesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SendEmailJSONRequestBody ¶
type SendEmailJSONRequestBody = V1SendRequest
SendEmailJSONRequestBody defines body for SendEmail for application/json ContentType.
type SendEmailResponse ¶
type SendEmailResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseSendEmailResponse ¶
func ParseSendEmailResponse(rsp *http.Response) (*SendEmailResponse, error)
ParseSendEmailResponse parses an HTTP response from a SendEmailWithResponse call
func (SendEmailResponse) ContentType ¶
func (r SendEmailResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (SendEmailResponse) GetBody ¶ added in v1.1.1
func (r SendEmailResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (SendEmailResponse) GetJSON401 ¶ added in v1.1.1
func (r SendEmailResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (SendEmailResponse) GetJSON403 ¶ added in v1.1.1
func (r SendEmailResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (SendEmailResponse) GetJSON422 ¶ added in v1.1.1
func (r SendEmailResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (SendEmailResponse) GetJSON500 ¶ added in v1.1.1
func (r SendEmailResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (SendEmailResponse) GetJSON502 ¶ added in v1.1.1
func (r SendEmailResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (SendEmailResponse) Status ¶
func (r SendEmailResponse) Status() string
Status returns HTTPResponse.Status
func (SendEmailResponse) StatusCode ¶
func (r SendEmailResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type TestWebhookResponse ¶
type TestWebhookResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1WebhooksTestResult
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseTestWebhookResponse ¶
func ParseTestWebhookResponse(rsp *http.Response) (*TestWebhookResponse, error)
ParseTestWebhookResponse parses an HTTP response from a TestWebhookWithResponse call
func (TestWebhookResponse) ContentType ¶
func (r TestWebhookResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (TestWebhookResponse) GetBody ¶ added in v1.1.1
func (r TestWebhookResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (TestWebhookResponse) GetJSON200 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON200() *V1WebhooksTestResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (TestWebhookResponse) GetJSON401 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (TestWebhookResponse) GetJSON403 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (TestWebhookResponse) GetJSON404 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (TestWebhookResponse) GetJSON500 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (TestWebhookResponse) GetJSON502 ¶ added in v1.1.1
func (r TestWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (TestWebhookResponse) Status ¶
func (r TestWebhookResponse) Status() string
Status returns HTTPResponse.Status
func (TestWebhookResponse) StatusCode ¶
func (r TestWebhookResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateFolderJSONRequestBody ¶
type UpdateFolderJSONRequestBody = V1FoldersUpdateRequest
UpdateFolderJSONRequestBody defines body for UpdateFolder for application/json ContentType.
type UpdateFolderResponse ¶
type UpdateFolderResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FoldersResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *CommonResponseConflictResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseUpdateFolderResponse ¶
func ParseUpdateFolderResponse(rsp *http.Response) (*UpdateFolderResponse, error)
ParseUpdateFolderResponse parses an HTTP response from a UpdateFolderWithResponse call
func (UpdateFolderResponse) ContentType ¶
func (r UpdateFolderResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UpdateFolderResponse) GetBody ¶ added in v1.1.1
func (r UpdateFolderResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UpdateFolderResponse) GetJSON200 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON200() *V1FoldersResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UpdateFolderResponse) GetJSON401 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (UpdateFolderResponse) GetJSON403 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (UpdateFolderResponse) GetJSON409 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON409() *CommonResponseConflictResponse
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (UpdateFolderResponse) GetJSON422 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (UpdateFolderResponse) GetJSON500 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (UpdateFolderResponse) GetJSON502 ¶ added in v1.1.1
func (r UpdateFolderResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (UpdateFolderResponse) Status ¶
func (r UpdateFolderResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateFolderResponse) StatusCode ¶
func (r UpdateFolderResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateMessageFlagsJSONRequestBody ¶
type UpdateMessageFlagsJSONRequestBody = V1FolderMessagesFlagsBulkRequest
UpdateMessageFlagsJSONRequestBody defines body for UpdateMessageFlags for application/json ContentType.
type UpdateMessageFlagsResponse ¶
type UpdateMessageFlagsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1FolderMessagesUpdateFlagsResult
// JSON207 the response for an HTTP 207 `application/json` response
JSON207 *V1FolderMessagesUpdateFlagsResult
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseUpdateMessageFlagsResponse ¶
func ParseUpdateMessageFlagsResponse(rsp *http.Response) (*UpdateMessageFlagsResponse, error)
ParseUpdateMessageFlagsResponse parses an HTTP response from a UpdateMessageFlagsWithResponse call
func (UpdateMessageFlagsResponse) ContentType ¶
func (r UpdateMessageFlagsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UpdateMessageFlagsResponse) GetBody ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UpdateMessageFlagsResponse) GetJSON200 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON200() *V1FolderMessagesUpdateFlagsResult
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON207 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON207() *V1FolderMessagesUpdateFlagsResult
GetJSON207 returns the response for an HTTP 207 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON401 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON403 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON422 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON500 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (UpdateMessageFlagsResponse) GetJSON502 ¶ added in v1.1.1
func (r UpdateMessageFlagsResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (UpdateMessageFlagsResponse) Status ¶
func (r UpdateMessageFlagsResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateMessageFlagsResponse) StatusCode ¶
func (r UpdateMessageFlagsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateWebhookJSONRequestBody ¶
type UpdateWebhookJSONRequestBody = V1WebhooksUpdateRequest
UpdateWebhookJSONRequestBody defines body for UpdateWebhook for application/json ContentType.
type UpdateWebhookResponse ¶
type UpdateWebhookResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *V1WebhooksResource
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *CommonResponseUnauthorizedResponse
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *CommonResponseForbiddenResponse
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *CommonResponseNotFoundResponse
// JSON422 the response for an HTTP 422 `application/json` response
JSON422 *CommonResponseValidationFailedResponse
// JSON500 the response for an HTTP 500 `application/json` response
JSON500 *CommonResponseInternalServerErrorResponse
// JSON502 the response for an HTTP 502 `application/json` response
JSON502 *CommonResponseBadGatewayResponse
}
func ParseUpdateWebhookResponse ¶
func ParseUpdateWebhookResponse(rsp *http.Response) (*UpdateWebhookResponse, error)
ParseUpdateWebhookResponse parses an HTTP response from a UpdateWebhookWithResponse call
func (UpdateWebhookResponse) ContentType ¶
func (r UpdateWebhookResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UpdateWebhookResponse) GetBody ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UpdateWebhookResponse) GetJSON200 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON200() *V1WebhooksResource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UpdateWebhookResponse) GetJSON401 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON401() *CommonResponseUnauthorizedResponse
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (UpdateWebhookResponse) GetJSON403 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON403() *CommonResponseForbiddenResponse
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (UpdateWebhookResponse) GetJSON404 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON404() *CommonResponseNotFoundResponse
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (UpdateWebhookResponse) GetJSON422 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON422() *CommonResponseValidationFailedResponse
GetJSON422 returns the response for an HTTP 422 `application/json` response
func (UpdateWebhookResponse) GetJSON500 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON500() *CommonResponseInternalServerErrorResponse
GetJSON500 returns the response for an HTTP 500 `application/json` response
func (UpdateWebhookResponse) GetJSON502 ¶ added in v1.1.1
func (r UpdateWebhookResponse) GetJSON502() *CommonResponseBadGatewayResponse
GetJSON502 returns the response for an HTTP 502 `application/json` response
func (UpdateWebhookResponse) Status ¶
func (r UpdateWebhookResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateWebhookResponse) StatusCode ¶
func (r UpdateWebhookResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type V1FolderMessagesCollection ¶
type V1FolderMessagesCollection struct {
Data []V1FolderMessagesMessage `json:"data"`
// Pagination Pagination metadata for paginated collections.
Pagination Pagination `json:"pagination"`
}
V1FolderMessagesCollection Paginated list of messages.
type V1FolderMessagesDeleteBulkRequest ¶
type V1FolderMessagesDeleteBulkRequest struct {
// Uids Message UIDs to delete. 1-100 entries, each > 0.
//
// Example: [42,43,44]
Uids []int `json:"uids"`
}
V1FolderMessagesDeleteBulkRequest Body for permanently deleting multiple messages.
type V1FolderMessagesFlagsBulkRequest ¶
type V1FolderMessagesFlagsBulkRequest struct {
// AddFlags Example: ["\\Seen","\\Flagged","$forwarded"]
AddFlags *[]string `json:"addFlags,omitempty"`
// RemoveFlags Example: ["\\Seen"]
RemoveFlags *[]string `json:"removeFlags,omitempty"`
// Uids Message UIDs to update. 1-100 entries, each > 0.
//
// Example: [42,43,44]
Uids []int `json:"uids"`
}
V1FolderMessagesFlagsBulkRequest Add and/or remove flags on multiple messages. At least one of addFlags or removeFlags must be set.
type V1FolderMessagesFlagsRequest ¶
type V1FolderMessagesFlagsRequest struct {
// AddFlags Example: ["\\Seen","\\Flagged","$forwarded"]
AddFlags *[]string `json:"addFlags,omitempty"`
// RemoveFlags Example: ["\\Seen"]
RemoveFlags *[]string `json:"removeFlags,omitempty"`
}
V1FolderMessagesFlagsRequest Add and/or remove flags on a message. At least one of addFlags or removeFlags must be set.
type V1FolderMessagesMessage ¶
type V1FolderMessagesMessage struct {
Attachments []V1FolderMessagesMessageAttachment `json:"attachments"`
Bcc []V1FolderMessagesMessageAddress `json:"bcc"`
Cc []V1FolderMessagesMessageAddress `json:"cc"`
// Date Example: 2024-01-15T10:30:00.000Z
Date time.Time `json:"date"`
// Flags Example: ["\\Seen","\\Flagged"]
Flags []string `json:"flags"`
From *V1FolderMessagesMessage_From `json:"from"`
// InReplyTo Example: <0987654321@example.com>
InReplyTo *string `json:"inReplyTo"`
// MessageId Example: <1234567890@example.com>
MessageId *string `json:"messageId"`
// Path Example: INBOX
Path string `json:"path"`
// Size Example: 2048
Size int `json:"size"`
// Subject Example: Test Email Subject
Subject *string `json:"subject"`
To []V1FolderMessagesMessageAddress `json:"to"`
// Uid Example: 123
Uid int `json:"uid"`
// Unseen Example: false
Unseen bool `json:"unseen"`
}
V1FolderMessagesMessage A message in a folder of the managed mailbox.
type V1FolderMessagesMessageAddress ¶
type V1FolderMessagesMessageAddress struct {
// Address Example: john@example.com
Address string `json:"address"`
// Name Example: John Doe
Name string `json:"name"`
}
V1FolderMessagesMessageAddress A single email address with optional display name.
type V1FolderMessagesMessageAttachment ¶
type V1FolderMessagesMessageAttachment struct {
// ContentId Example: <attachment@example.com>
ContentId *string `json:"contentId"`
// ContentType Example: application/pdf
ContentType string `json:"contentType"`
// Filename Example: document.pdf
Filename *string `json:"filename"`
// Id Opaque attachment identifier. Use as the {attachmentId} path parameter on the download endpoint.
//
// Example: YXR0YWNobWVudDpJTkJPWDoxMjM6MS4y
Id string `json:"id"`
// Inline Example: false
Inline bool `json:"inline"`
// SizeBytes Example: 1024
SizeBytes int `json:"sizeBytes"`
}
V1FolderMessagesMessageAttachment Attachment metadata attached to a message.
type V1FolderMessagesMessageText ¶
type V1FolderMessagesMessageText struct {
// Html Example: <p>Hello world</p>
Html string `json:"html"`
// Text Example: Hello world
Text string `json:"text"`
}
V1FolderMessagesMessageText Rendered text and HTML parts of a message.
type V1FolderMessagesMessageTextResource ¶
type V1FolderMessagesMessageTextResource struct {
// Data Rendered text and HTML parts of a message.
Data V1FolderMessagesMessageText `json:"data"`
}
V1FolderMessagesMessageTextResource Single message text payload.
type V1FolderMessagesMessage_From ¶
type V1FolderMessagesMessage_From struct {
// contains filtered or unexported fields
}
V1FolderMessagesMessage_From defines model for V1FolderMessagesMessage.From.
func (V1FolderMessagesMessage_From) AsV1FolderMessagesMessageAddress ¶
func (t V1FolderMessagesMessage_From) AsV1FolderMessagesMessageAddress() (V1FolderMessagesMessageAddress, error)
AsV1FolderMessagesMessageAddress returns the union data inside the V1FolderMessagesMessage_From as a V1FolderMessagesMessageAddress
func (*V1FolderMessagesMessage_From) FromV1FolderMessagesMessageAddress ¶
func (t *V1FolderMessagesMessage_From) FromV1FolderMessagesMessageAddress(v V1FolderMessagesMessageAddress) error
FromV1FolderMessagesMessageAddress overwrites any union data inside the V1FolderMessagesMessage_From as the provided V1FolderMessagesMessageAddress
func (V1FolderMessagesMessage_From) MarshalJSON ¶
func (t V1FolderMessagesMessage_From) MarshalJSON() ([]byte, error)
func (*V1FolderMessagesMessage_From) MergeV1FolderMessagesMessageAddress ¶
func (t *V1FolderMessagesMessage_From) MergeV1FolderMessagesMessageAddress(v V1FolderMessagesMessageAddress) error
MergeV1FolderMessagesMessageAddress performs a merge with any union data inside the V1FolderMessagesMessage_From, using the provided V1FolderMessagesMessageAddress
func (*V1FolderMessagesMessage_From) UnmarshalJSON ¶
func (t *V1FolderMessagesMessage_From) UnmarshalJSON(b []byte) error
type V1FolderMessagesMoveBulkRequest ¶
type V1FolderMessagesMoveBulkRequest struct {
// TargetFolder Destination folder path.
//
// Example: INBOX.Sent
TargetFolder string `json:"targetFolder"`
// Uids Message UIDs to move. 1-100 entries, each > 0.
//
// Example: [42,43,44]
Uids []int `json:"uids"`
}
V1FolderMessagesMoveBulkRequest Body for moving multiple messages to a target folder.
type V1FolderMessagesMoveRequest ¶
type V1FolderMessagesMoveRequest struct {
// TargetFolder Destination folder path.
//
// Example: INBOX.Sent
TargetFolder string `json:"targetFolder"`
}
V1FolderMessagesMoveRequest Body for moving a single message to a target folder.
type V1FolderMessagesResource ¶
type V1FolderMessagesResource struct {
// Data A message in a folder of the managed mailbox.
Data V1FolderMessagesMessage `json:"data"`
}
V1FolderMessagesResource Single message payload.
type V1FolderMessagesSearchRequest ¶
type V1FolderMessagesSearchRequest struct {
// Before Example: 2024-12-31
Before *openapi_types.Date `json:"before,omitempty"`
// Body Example: important
Body *string `json:"body,omitempty"`
// Cc Example: team@example.com
Cc *string `json:"cc,omitempty"`
// Flags Example: ["\\Seen","\\Flagged"]
Flags *[]string `json:"flags,omitempty"`
// From Example: john@example.com
From *string `json:"from,omitempty"`
// Header Example: X-Custom-Header:value
Header *string `json:"header,omitempty"`
// Larger Example: 1024
Larger *int `json:"larger,omitempty"`
// Since Example: 2024-01-01
Since *openapi_types.Date `json:"since,omitempty"`
// Smaller Example: 1048576
Smaller *int `json:"smaller,omitempty"`
// Subject Example: meeting
Subject *string `json:"subject,omitempty"`
// Text Example: urgent
Text *string `json:"text,omitempty"`
// To Example: jane@example.com
To *string `json:"to,omitempty"`
// Uid Example: 1:100
Uid *string `json:"uid,omitempty"`
}
V1FolderMessagesSearchRequest Search criteria. All fields optional; combine to narrow results.
type V1FolderMessagesUpdateFlagsResult ¶
type V1FolderMessagesUpdateFlagsResult struct {
Data struct {
Failed []struct {
// Reason Example: Failed to update message flags
Reason string `json:"reason"`
// Uid Example: 44
Uid int `json:"uid"`
} `json:"failed"`
// Successful Example: [42,43]
Successful []int `json:"successful"`
} `json:"data"`
}
V1FolderMessagesUpdateFlagsResult Per-UID outcome of a bulk flag update. 200 when every UID succeeded, 207 when at least one failed.
type V1FoldersCollection ¶
type V1FoldersCollection struct {
Data []V1FoldersFolder `json:"data"`
// Pagination Pagination metadata for paginated collections.
Pagination Pagination `json:"pagination"`
}
V1FoldersCollection Paginated list of folders.
type V1FoldersCreateRequest ¶
type V1FoldersCreateRequest struct {
// Name Folder name. Length 1-100 after trimming.
//
// Example: Projects
Name string `json:"name"`
}
V1FoldersCreateRequest Body for creating a folder.
type V1FoldersFolder ¶
type V1FoldersFolder struct {
// Delimiter Hierarchy delimiter used by the IMAP server.
//
// Example: .
Delimiter string `json:"delimiter"`
// MessageCount Total number of messages in the folder.
//
// Example: 42
MessageCount int `json:"messageCount"`
// Name Leaf name of the folder.
//
// Example: Sent
Name string `json:"name"`
// Path Full hierarchical folder path including the delimiter.
//
// Example: INBOX.Sent
Path string `json:"path"`
// SpecialUse IMAP SPECIAL-USE attribute (RFC 6154). `null` for regular folders.
//
// Example: \Sent
SpecialUse *string `json:"specialUse"`
// UnreadCount Number of unread messages in the folder.
//
// Example: 5
UnreadCount int `json:"unreadCount"`
}
V1FoldersFolder A folder (IMAP mailbox) in the managed mailbox.
type V1FoldersResource ¶
type V1FoldersResource struct {
// Data A folder (IMAP mailbox) in the managed mailbox.
Data V1FoldersFolder `json:"data"`
}
V1FoldersResource Single folder payload.
type V1FoldersUpdateRequest ¶
type V1FoldersUpdateRequest struct {
// Name New folder name. Length 1-100 after trimming.
//
// Example: Archive
Name string `json:"name"`
}
V1FoldersUpdateRequest Body for renaming a folder.
type V1MeMailbox ¶
type V1MeMailbox struct {
// Address Email address of the mailbox.
//
// Example: user@example.com
Address openapi_types.Email `json:"address"`
// ResourceId Unique identifier of the mailbox.
//
// Example: AC1a2b3c4d5e6f7g
ResourceId string `json:"resourceId"`
}
V1MeMailbox A mailbox the authenticated API token can manage.
type V1MeResource ¶
type V1MeResource struct {
Data struct {
// Mailboxes Mailboxes that the authenticated API token can manage.
Mailboxes []V1MeMailbox `json:"mailboxes"`
// OrderResourceId Identifier of the order this API token is scoped to.
//
// Example: OR1a2b3c4d5e6f7g
OrderResourceId string `json:"orderResourceId"`
} `json:"data"`
}
V1MeResource Authenticated account payload.
type V1QuotaQuota ¶
type V1QuotaQuota struct {
// Quotas Per-resource quota breakdown reported by the IMAP server.
Quotas []V1QuotaQuotaResource `json:"quotas"`
// Supported Whether the IMAP server reports quota information for this mailbox.
//
// Example: true
Supported bool `json:"supported"`
// TotalLimit Aggregate storage limit across all resources, in bytes.
//
// Example: 1073741824
TotalLimit int `json:"totalLimit"`
// TotalPercentage Aggregate storage usage as a percentage of the total limit.
//
// Example: 0
TotalPercentage int `json:"totalPercentage"`
// TotalUsage Aggregate storage usage across all resources, in bytes.
//
// Example: 1048576
TotalUsage int `json:"totalUsage"`
}
V1QuotaQuota Storage and message quota usage for the managed mailbox.
type V1QuotaQuotaResource ¶
type V1QuotaQuotaResource struct {
// Limit Maximum allowed value for the resource (bytes for STORAGE, count for MESSAGE).
//
// Example: 1073741824
Limit int `json:"limit"`
// Percentage Usage as a percentage of the limit.
//
// Example: 0
Percentage int `json:"percentage"`
// ResourceName Name of the quota resource as reported by the IMAP server.
//
// Example: STORAGE
ResourceName string `json:"resourceName"`
// Usage Current usage of the resource (bytes for STORAGE, count for MESSAGE).
//
// Example: 1048576
Usage int `json:"usage"`
}
V1QuotaQuotaResource Usage and limit for a single IMAP quota resource.
type V1QuotaResource ¶
type V1QuotaResource struct {
// Data Storage and message quota usage for the managed mailbox.
Data V1QuotaQuota `json:"data"`
}
V1QuotaResource Mailbox quota payload.
type V1SendAttachment ¶
type V1SendAttachment struct {
// Cid Content-ID for inline images. Reference from HTML as <img src="cid:logo">.
//
// Example: logo
Cid *string `json:"cid,omitempty"`
// Content Attachment body. Base64-encoded by default; set encoding to switch.
//
// Example: JVBERi0xLjQK...
Content string `json:"content"`
// ContentType Example: application/pdf
ContentType *string `json:"contentType,omitempty"`
// Encoding Encoding of content. Defaults to base64.
//
// Example: base64
Encoding *string `json:"encoding,omitempty"`
// Filename Example: invoice.pdf
Filename string `json:"filename"`
}
V1SendAttachment Attachment payload for outgoing mail. Supports regular attachments and inline images linked via Content-ID.
type V1SendMessageRef ¶
type V1SendMessageRef struct {
// Folder Folder containing the source message.
//
// Example: INBOX
Folder string `json:"folder"`
// Uid UID of the source message.
//
// Example: 123
Uid int `json:"uid"`
}
V1SendMessageRef Reference to a source message by UID within a folder, used for reply/forward threading. Both fields are required.
type V1SendRequest ¶
type V1SendRequest struct {
Attachments *[]V1SendAttachment `json:"attachments,omitempty"`
// Bcc Example: ["bcc@example.com"]
Bcc *[]openapi_types.Email `json:"bcc,omitempty"`
// Cc Example: ["cc@example.com"]
Cc *[]openapi_types.Email `json:"cc,omitempty"`
// DisplayName Example: John Doe
DisplayName *string `json:"displayName,omitempty"`
// ForwardOf Source message this forwards. Copies its Message-Id/References into In-Reply-To/References and flags it $forwarded. Mutually exclusive with inReplyTo.
ForwardOf *V1SendMessageRef `json:"forwardOf,omitempty"`
// Html Example: <p>HTML body</p>
Html *string `json:"html,omitempty"`
// InReplyTo Source message this is a reply to. Copies its Message-Id/References into In-Reply-To/References and flags it \Answered. Mutually exclusive with forwardOf.
InReplyTo *V1SendMessageRef `json:"inReplyTo,omitempty"`
// Subject Example: Hello
Subject *string `json:"subject,omitempty"`
// Text Example: Plain body
Text *string `json:"text,omitempty"`
// To Example: ["recipient@example.com"]
To *[]openapi_types.Email `json:"to,omitempty"`
// contains filtered or unexported fields
}
V1SendRequest Outgoing message payload. At least one of to, cc, or bcc must be present.
func (V1SendRequest) AsV1SendRequest0 ¶
func (t V1SendRequest) AsV1SendRequest0() (V1SendRequest0, error)
AsV1SendRequest0 returns the union data inside the V1SendRequest as a V1SendRequest0
func (V1SendRequest) AsV1SendRequest1 ¶
func (t V1SendRequest) AsV1SendRequest1() (V1SendRequest1, error)
AsV1SendRequest1 returns the union data inside the V1SendRequest as a V1SendRequest1
func (V1SendRequest) AsV1SendRequest2 ¶
func (t V1SendRequest) AsV1SendRequest2() (V1SendRequest2, error)
AsV1SendRequest2 returns the union data inside the V1SendRequest as a V1SendRequest2
func (*V1SendRequest) FromV1SendRequest0 ¶
func (t *V1SendRequest) FromV1SendRequest0(v V1SendRequest0) error
FromV1SendRequest0 overwrites any union data inside the V1SendRequest as the provided V1SendRequest0
func (*V1SendRequest) FromV1SendRequest1 ¶
func (t *V1SendRequest) FromV1SendRequest1(v V1SendRequest1) error
FromV1SendRequest1 overwrites any union data inside the V1SendRequest as the provided V1SendRequest1
func (*V1SendRequest) FromV1SendRequest2 ¶
func (t *V1SendRequest) FromV1SendRequest2(v V1SendRequest2) error
FromV1SendRequest2 overwrites any union data inside the V1SendRequest as the provided V1SendRequest2
func (V1SendRequest) MarshalJSON ¶
func (t V1SendRequest) MarshalJSON() ([]byte, error)
func (*V1SendRequest) MergeV1SendRequest0 ¶
func (t *V1SendRequest) MergeV1SendRequest0(v V1SendRequest0) error
MergeV1SendRequest0 performs a merge with any union data inside the V1SendRequest, using the provided V1SendRequest0
func (*V1SendRequest) MergeV1SendRequest1 ¶
func (t *V1SendRequest) MergeV1SendRequest1(v V1SendRequest1) error
MergeV1SendRequest1 performs a merge with any union data inside the V1SendRequest, using the provided V1SendRequest1
func (*V1SendRequest) MergeV1SendRequest2 ¶
func (t *V1SendRequest) MergeV1SendRequest2(v V1SendRequest2) error
MergeV1SendRequest2 performs a merge with any union data inside the V1SendRequest, using the provided V1SendRequest2
func (*V1SendRequest) UnmarshalJSON ¶
func (t *V1SendRequest) UnmarshalJSON(b []byte) error
type V1SendRequest0 ¶
type V1SendRequest0 = interface{}
V1SendRequest0 defines model for V1SendRequest.0.
type V1SendRequest1 ¶
type V1SendRequest1 = interface{}
V1SendRequest1 defines model for V1SendRequest.1.
type V1SendRequest2 ¶
type V1SendRequest2 = interface{}
V1SendRequest2 defines model for V1SendRequest.2.
type V1WebhooksCollection ¶
type V1WebhooksCollection struct {
Data []V1WebhooksWebhook `json:"data"`
// Pagination Pagination metadata for paginated collections.
Pagination Pagination `json:"pagination"`
}
V1WebhooksCollection Paginated list of webhooks.
type V1WebhooksCreateRequest ¶
type V1WebhooksCreateRequest struct {
// Description Example: Notifies CRM on new mail
Description *string `json:"description,omitempty"`
// Events Example: ["message.received"]
Events []V1WebhooksCreateRequestEvents `json:"events"`
// Name Example: New message notifier
Name string `json:"name"`
// Status Example: active
Status *V1WebhooksCreateRequestStatus `json:"status,omitempty"`
// Url Example: https://example.com/webhooks/incoming
Url string `json:"url"`
}
V1WebhooksCreateRequest Body for creating a webhook.
type V1WebhooksCreateRequestEvents ¶
type V1WebhooksCreateRequestEvents string
V1WebhooksCreateRequestEvents defines model for V1WebhooksCreateRequest.Events.
const (
V1WebhooksCreateRequestEventsMessageReceived V1WebhooksCreateRequestEvents = "message.received"
)
Defines values for V1WebhooksCreateRequestEvents.
func (V1WebhooksCreateRequestEvents) Valid ¶
func (e V1WebhooksCreateRequestEvents) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksCreateRequestEvents enum.
type V1WebhooksCreateRequestStatus ¶
type V1WebhooksCreateRequestStatus string
V1WebhooksCreateRequestStatus Example: active
const ( V1WebhooksCreateRequestStatusActive V1WebhooksCreateRequestStatus = "active" V1WebhooksCreateRequestStatusDisabled V1WebhooksCreateRequestStatus = "disabled" V1WebhooksCreateRequestStatusPaused V1WebhooksCreateRequestStatus = "paused" )
Defines values for V1WebhooksCreateRequestStatus.
func (V1WebhooksCreateRequestStatus) Valid ¶
func (e V1WebhooksCreateRequestStatus) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksCreateRequestStatus enum.
type V1WebhooksResource ¶
type V1WebhooksResource struct {
// Data Webhook configured for a managed mailbox.
Data V1WebhooksWebhook `json:"data"`
}
V1WebhooksResource Single webhook payload.
type V1WebhooksResourceWithSecret ¶
type V1WebhooksResourceWithSecret struct {
// Data Webhook payload that includes the one-time `secret`. Returned at creation and after secret regeneration. The secret is delivered as a bearer token on every webhook request (`Authorization: Bearer <secret>`); store it securely as it is not returned again.
Data V1WebhooksWebhookWithSecret `json:"data"`
}
V1WebhooksResourceWithSecret Single webhook payload including the one-time secret.
type V1WebhooksTestResult ¶
type V1WebhooksTestResult struct {
Data struct {
// Error Example: Connection refused
Error *string `json:"error,omitempty"`
// HttpStatus Example: 200
HttpStatus int `json:"httpStatus"`
// Success Example: true
Success *bool `json:"success,omitempty"`
} `json:"data"`
}
V1WebhooksTestResult Result of a webhook test delivery.
type V1WebhooksUpdateRequest ¶
type V1WebhooksUpdateRequest struct {
// Description Example: Updated description
Description *string `json:"description,omitempty"`
// Events Example: ["message.received"]
Events *[]V1WebhooksUpdateRequestEvents `json:"events,omitempty"`
// Name Example: Renamed webhook
Name *string `json:"name,omitempty"`
// Status Example: paused
Status *V1WebhooksUpdateRequestStatus `json:"status,omitempty"`
// Url Example: https://example.com/webhooks/new
Url *string `json:"url,omitempty"`
}
V1WebhooksUpdateRequest Body for partially updating a webhook. All fields optional; only present fields are applied.
type V1WebhooksUpdateRequestEvents ¶
type V1WebhooksUpdateRequestEvents string
V1WebhooksUpdateRequestEvents defines model for V1WebhooksUpdateRequest.Events.
const (
V1WebhooksUpdateRequestEventsMessageReceived V1WebhooksUpdateRequestEvents = "message.received"
)
Defines values for V1WebhooksUpdateRequestEvents.
func (V1WebhooksUpdateRequestEvents) Valid ¶
func (e V1WebhooksUpdateRequestEvents) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksUpdateRequestEvents enum.
type V1WebhooksUpdateRequestStatus ¶
type V1WebhooksUpdateRequestStatus string
V1WebhooksUpdateRequestStatus Example: paused
const ( V1WebhooksUpdateRequestStatusActive V1WebhooksUpdateRequestStatus = "active" V1WebhooksUpdateRequestStatusDisabled V1WebhooksUpdateRequestStatus = "disabled" V1WebhooksUpdateRequestStatusPaused V1WebhooksUpdateRequestStatus = "paused" )
Defines values for V1WebhooksUpdateRequestStatus.
func (V1WebhooksUpdateRequestStatus) Valid ¶
func (e V1WebhooksUpdateRequestStatus) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksUpdateRequestStatus enum.
type V1WebhooksWebhook ¶
type V1WebhooksWebhook struct {
// AccountResourceId Resource ID of the mailbox this webhook is attached to.
//
// Example: AC1a2b3c4d5e6f7g
AccountResourceId string `json:"accountResourceId"`
// CreatedAt Example: 2026-04-07T12:00:00+00:00
CreatedAt time.Time `json:"createdAt"`
// Description Example: Notifies our CRM when a new email arrives
Description *string `json:"description"`
Events []V1WebhooksWebhookEvents `json:"events"`
// Id Unique webhook identifier (UUID v7).
//
// Example: 019683f8-1234-7abc-8def-0123456789ab
Id openapi_types.UUID `json:"id"`
// Mailbox Email address of the mailbox.
//
// Example: user@example.com
Mailbox string `json:"mailbox"`
// Name Example: New message notifier
Name string `json:"name"`
// Status Example: active
Status V1WebhooksWebhookStatus `json:"status"`
// UpdatedAt Example: 2026-04-07T12:00:00+00:00
UpdatedAt time.Time `json:"updatedAt"`
// Url Example: https://example.com/webhooks/incoming
Url string `json:"url"`
}
V1WebhooksWebhook Webhook configured for a managed mailbox.
type V1WebhooksWebhookEvents ¶
type V1WebhooksWebhookEvents string
V1WebhooksWebhookEvents Example: message.received
const (
V1WebhooksWebhookEventsMessageReceived V1WebhooksWebhookEvents = "message.received"
)
Defines values for V1WebhooksWebhookEvents.
func (V1WebhooksWebhookEvents) Valid ¶
func (e V1WebhooksWebhookEvents) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksWebhookEvents enum.
type V1WebhooksWebhookStatus ¶
type V1WebhooksWebhookStatus string
V1WebhooksWebhookStatus Example: active
const ( V1WebhooksWebhookStatusActive V1WebhooksWebhookStatus = "active" V1WebhooksWebhookStatusDisabled V1WebhooksWebhookStatus = "disabled" V1WebhooksWebhookStatusPaused V1WebhooksWebhookStatus = "paused" )
Defines values for V1WebhooksWebhookStatus.
func (V1WebhooksWebhookStatus) Valid ¶
func (e V1WebhooksWebhookStatus) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksWebhookStatus enum.
type V1WebhooksWebhookWithSecret ¶
type V1WebhooksWebhookWithSecret struct {
// AccountResourceId Resource ID of the mailbox this webhook is attached to.
//
// Example: AC1a2b3c4d5e6f7g
AccountResourceId string `json:"accountResourceId"`
// CreatedAt Example: 2026-04-07T12:00:00+00:00
CreatedAt time.Time `json:"createdAt"`
// Description Example: Notifies our CRM when a new email arrives
Description *string `json:"description"`
Events []V1WebhooksWebhookWithSecretEvents `json:"events"`
// Id Unique webhook identifier (UUID v7).
//
// Example: 019683f8-1234-7abc-8def-0123456789ab
Id openapi_types.UUID `json:"id"`
// Mailbox Email address of the mailbox.
//
// Example: user@example.com
Mailbox string `json:"mailbox"`
// Name Example: New message notifier
Name string `json:"name"`
// Secret Example: 4a6f8b2d1e9c3f7a0b5d8e2c4f1a7b3d9e6c2f8a1b4d7e0c3f6a9b2d5e8c1f4
Secret string `json:"secret"`
// Status Example: active
Status V1WebhooksWebhookWithSecretStatus `json:"status"`
// UpdatedAt Example: 2026-04-07T12:00:00+00:00
UpdatedAt time.Time `json:"updatedAt"`
// Url Example: https://example.com/webhooks/incoming
Url string `json:"url"`
}
V1WebhooksWebhookWithSecret Webhook payload that includes the one-time `secret`. Returned at creation and after secret regeneration. The secret is delivered as a bearer token on every webhook request (`Authorization: Bearer <secret>`); store it securely as it is not returned again.
type V1WebhooksWebhookWithSecretEvents ¶
type V1WebhooksWebhookWithSecretEvents string
V1WebhooksWebhookWithSecretEvents Example: message.received
const (
V1WebhooksWebhookWithSecretEventsMessageReceived V1WebhooksWebhookWithSecretEvents = "message.received"
)
Defines values for V1WebhooksWebhookWithSecretEvents.
func (V1WebhooksWebhookWithSecretEvents) Valid ¶
func (e V1WebhooksWebhookWithSecretEvents) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksWebhookWithSecretEvents enum.
type V1WebhooksWebhookWithSecretStatus ¶
type V1WebhooksWebhookWithSecretStatus string
V1WebhooksWebhookWithSecretStatus Example: active
const ( V1WebhooksWebhookWithSecretStatusActive V1WebhooksWebhookWithSecretStatus = "active" V1WebhooksWebhookWithSecretStatusDisabled V1WebhooksWebhookWithSecretStatus = "disabled" V1WebhooksWebhookWithSecretStatusPaused V1WebhooksWebhookWithSecretStatus = "paused" )
Defines values for V1WebhooksWebhookWithSecretStatus.
func (V1WebhooksWebhookWithSecretStatus) Valid ¶
func (e V1WebhooksWebhookWithSecretStatus) Valid() bool
Valid indicates whether the value is a known member of the V1WebhooksWebhookWithSecretStatus enum.