Documentation
¶
Index ¶
- type Client
- func (c *Client) Create(ctx context.Context, request *management.CreateEmailTemplateRequestContent, ...) (*management.CreateEmailTemplateResponseContent, error)
- func (c *Client) Get(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*management.GetEmailTemplateResponseContent, error)
- func (c *Client) Set(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*management.SetEmailTemplateResponseContent, error)
- func (c *Client) Update(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*management.UpdateEmailTemplateResponseContent, error)
- type RawClient
- func (r *RawClient) Create(ctx context.Context, request *management.CreateEmailTemplateRequestContent, ...) (*core.Response[*management.CreateEmailTemplateResponseContent], error)
- func (r *RawClient) Get(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*core.Response[*management.GetEmailTemplateResponseContent], error)
- func (r *RawClient) Set(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*core.Response[*management.SetEmailTemplateResponseContent], error)
- func (r *RawClient) Update(ctx context.Context, templateName *management.EmailTemplateNameEnum, ...) (*core.Response[*management.UpdateEmailTemplateResponseContent], error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
WithRawResponse *RawClient
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(options *core.RequestOptions) *Client
func (*Client) Create ¶
func (c *Client) Create( ctx context.Context, request *management.CreateEmailTemplateRequestContent, opts ...option.RequestOption, ) (*management.CreateEmailTemplateResponseContent, error)
Create an email template.
func (*Client) Get ¶
func (c *Client) Get( ctx context.Context, templateName *management.EmailTemplateNameEnum, opts ...option.RequestOption, ) (*management.GetEmailTemplateResponseContent, error)
Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, and `async_approval`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
func (*Client) Set ¶
func (c *Client) Set( ctx context.Context, templateName *management.EmailTemplateNameEnum, request *management.SetEmailTemplateRequestContent, opts ...option.RequestOption, ) (*management.SetEmailTemplateResponseContent, error)
Update an email template.
func (*Client) Update ¶
func (c *Client) Update( ctx context.Context, templateName *management.EmailTemplateNameEnum, request *management.UpdateEmailTemplateRequestContent, opts ...option.RequestOption, ) (*management.UpdateEmailTemplateResponseContent, error)
Modify an email template.
type RawClient ¶
type RawClient struct {
// contains filtered or unexported fields
}
func NewRawClient ¶
func NewRawClient(options *core.RequestOptions) *RawClient
func (*RawClient) Create ¶
func (r *RawClient) Create( ctx context.Context, request *management.CreateEmailTemplateRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.CreateEmailTemplateResponseContent], error)
func (*RawClient) Get ¶
func (r *RawClient) Get( ctx context.Context, templateName *management.EmailTemplateNameEnum, opts ...option.RequestOption, ) (*core.Response[*management.GetEmailTemplateResponseContent], error)
func (*RawClient) Set ¶
func (r *RawClient) Set( ctx context.Context, templateName *management.EmailTemplateNameEnum, request *management.SetEmailTemplateRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.SetEmailTemplateResponseContent], error)
func (*RawClient) Update ¶
func (r *RawClient) Update( ctx context.Context, templateName *management.EmailTemplateNameEnum, request *management.UpdateEmailTemplateRequestContent, opts ...option.RequestOption, ) (*core.Response[*management.UpdateEmailTemplateResponseContent], error)
Click to show internal directories.
Click to hide internal directories.