action

type Action struct {
	// contains filtered or unexported fields
}

type ActionImmutable struct {
	Kind ActionKind `json:"kind"`
	// The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
	Name string `json:"name"`
	// The date and time this action template was created (ISO-8601 date/time with zone).
	CreatedAt *string `json:"createdAt,omitempty"`
	// The principal that created this action template.
	CreatedBy *string `json:"createdBy,omitempty"`
	// The date and time this action template was updated (ISO-8601 date/time with zone).
	UpdatedAt *string `json:"updatedAt,omitempty"`
	// The principal that updated this action template.
	UpdatedBy *string `json:"updatedBy,omitempty"`
}

type ActionKind string

type ActionMutable struct {
	// contains filtered or unexported fields
}

type ActionResult struct {
	ActionName string      `json:"actionName"`
	State      StatusState `json:"state"`
	StatusId   string      `json:"statusId"`
	Message    *string     `json:"message,omitempty"`
}

type ActionResultEmailDetail struct {
	EmailAddress *string                       `json:"emailAddress,omitempty"`
	State        *ActionResultEmailDetailState `json:"state,omitempty"`
}

type ActionResultEmailDetailState string

type EmailAction struct {
	Kind ActionKind `json:"kind"`
	// The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
	Name string `json:"name"`
	// An array of email addresses to include as recipients. Requires a special permission set for use. Please DO NOT include actual bouncing emails in automated testing.
	Addresses []string `json:"addresses,omitempty"`
	// HTML content to send as the body of the email. You can use a template in this field.
	Body *string `json:"body,omitempty"`
	// Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.
	BodyPlainText *string `json:"bodyPlainText,omitempty"`
	// The date and time this action template was created (ISO-8601 date/time with zone).
	CreatedAt *string `json:"createdAt,omitempty"`
	// The principal that created this action template.
	CreatedBy *string `json:"createdBy,omitempty"`
	// Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.
	FromName *string `json:"fromName,omitempty"`
	// An array of tenant member names, whose profile email addresses will be included as recipients.
	Members []string `json:"members,omitempty"`
	// The subject of the email. You can use a template in this field.
	Subject *string `json:"subject,omitempty"`
	// A human-readable title for the action. Must be less than or equal to 128 characters.
	Title *string `json:"title,omitempty"`
	// The date and time this action template was updated (ISO-8601 date/time with zone).
	UpdatedAt *string `json:"updatedAt,omitempty"`
	// The principal that updated this action template.
	UpdatedBy *string `json:"updatedBy,omitempty"`
}

type EmailActionMutable struct {
	// An array of email addresses to include as recipients. Requires a special permission set for use. Please DO NOT include actual bouncing emails in automated testing.
	Addresses []string `json:"addresses,omitempty"`
	// HTML content to send as the body of the email. You can use a template in this field.
	Body *string `json:"body,omitempty"`
	// Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.
	BodyPlainText *string `json:"bodyPlainText,omitempty"`
	// Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.
	FromName *string `json:"fromName,omitempty"`
	// An array of tenant member names, whose profile email addresses will be included as recipients.
	Members []string `json:"members,omitempty"`
	// The subject of the email. You can use a template in this field.
	Subject *string `json:"subject,omitempty"`
	// A human-readable title for the action. Must be less than or equal to 128 characters.
	Title *string `json:"title,omitempty"`
}

type PublicWebhookKey struct {
	// A PEM-formatted, ASN.1 DER-encoded PKCS#1 key.
	Key string `json:"key"`
}

type RawJsonPayload map[string]interface{}

type Service services.BaseService

type ServiceError struct {
	Code     string                 `json:"code"`
	Message  string                 `json:"message"`
	Details  map[string]interface{} `json:"details,omitempty"`
	MoreInfo *string                `json:"moreInfo,omitempty"`
}

type Servicer interface {
	//interfaces that cannot be auto-generated from codegen
	/*
		TriggerActionWithStatus - Trigger an action and return a TriggerResponse with StatusID

		Parameters:
			actionName: The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			triggerEvent: The action payload, which must include values for any templated fields.
	*/
	TriggerActionWithStatus(actionName string, triggerEvent TriggerEvent) (*TriggerResponse, error)

	//interfaces that are auto-generated in interface_generated.go
	ServicerGenerated
}

type ServicerGenerated interface {
	/*
		CreateAction - Creates an action template.
		Parameters:
			action: The action template to create.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateAction(action Action, resp ...*http.Response) (*Action, error)
	/*
		DeleteAction - Removes an action template.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteAction(actionName string, resp ...*http.Response) error
	/*
		GetAction - Returns a specific action template.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetAction(actionName string, resp ...*http.Response) (*Action, error)
	/*
		GetActionStatus - Returns the status of an action that was invoked. The status is available for 4 days after the last status change.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			statusId: The ID of the action status.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetActionStatus(actionName string, statusId string, resp ...*http.Response) (*ActionResult, error)
	/*
		GetActionStatusDetails - Returns the status details of the invoked email action. The status is available for 4 days after the last status change.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			statusId: The ID of the action status.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetActionStatusDetails(actionName string, statusId string, resp ...*http.Response) ([]ActionResultEmailDetail, error)
	/*
		GetPublicWebhookKeys - Returns an array of one or two webhook keys. The first key is active. The second key, if present, is expired.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPublicWebhookKeys(resp ...*http.Response) ([]PublicWebhookKey, error)
	/*
		ListActions - Returns the list of action templates.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListActions(resp ...*http.Response) ([]Action, error)
	/*
		TriggerAction - Invokes an action.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			triggerEvent: The action payload, which should include values for any templated fields.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	TriggerAction(actionName string, triggerEvent TriggerEvent, resp ...*http.Response) error
	/*
		UpdateAction - Modifies an action template.
		Parameters:
			actionName: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
			actionMutable: Updates to the action template.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateAction(actionName string, actionMutable ActionMutable, resp ...*http.Response) (*Action, error)
}

type StatusState string

type TriggerEvent struct {
	ActionMetadata *TriggerEventActionMetadata `json:"actionMetadata,omitempty"`
	// string-ified ISO-8601 date/time with zone.
	CreatedAt *string `json:"createdAt,omitempty"`
	// The principal that generated the trigger event.
	CreatedBy *string `json:"createdBy,omitempty"`
	// A unique identifier for this trigger event. Generated from a hash of all recursively-sorted event field values.
	Id      *string           `json:"id,omitempty"`
	Kind    *TriggerEventKind `json:"kind,omitempty"`
	Payload *RawJsonPayload   `json:"payload,omitempty"`
	// The tenant within which the trigger event was generated.
	Tenant *string `json:"tenant,omitempty"`
	// A description of the condition that caused the trigger event.
	TriggerCondition *string `json:"triggerCondition,omitempty"`
	// The name of the trigger for which this event was created.
	TriggerName *string `json:"triggerName,omitempty"`
	// A time to live (TTL), expressed as seconds after createdAt, after which the trigger event will no longer be acted upon.
	TtlSeconds *int32 `json:"ttlSeconds,omitempty"`
}

type TriggerEventActionMetadata struct {
	// An array of email addresses to include as recipients. Requires a special permission set for use. Please DO NOT include actual bouncing emails in automated testing.
	Addresses []string `json:"addresses,omitempty"`
	// An array of tenant member names, whose profile email addresses will be included as recipients.
	Members []string `json:"members,omitempty"`
}

type TriggerEventKind string

type TriggerResponse struct {
	StatusID  *string
	StatusURL *url.URL
}

type WebhookAction struct {
	Kind ActionKind `json:"kind"`
	// The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
	Name string `json:"name"`
	// The (possibly) templated payload body, which is POSTed to the webhookUrl when invoked.
	WebhookPayload string `json:"webhookPayload"`
	// Only HTTPS is allowed.
	WebhookUrl string `json:"webhookUrl"`
	// The date and time this action template was created (ISO-8601 date/time with zone).
	CreatedAt *string `json:"createdAt,omitempty"`
	// The principal that created this action template.
	CreatedBy *string `json:"createdBy,omitempty"`
	// A human-readable title for the action. Must be less than 128 characters.
	Title *string `json:"title,omitempty"`
	// The date and time this action template was updated (ISO-8601 date/time with zone).
	UpdatedAt *string `json:"updatedAt,omitempty"`
	// The principal that updated this action template.
	UpdatedBy      *string             `json:"updatedBy,omitempty"`
	WebhookHeaders map[string][]string `json:"webhookHeaders,omitempty"`
}

type WebhookActionMutable struct {
	// A human-readable title for the action. Must be less than 128 characters.
	Title          *string             `json:"title,omitempty"`
	WebhookHeaders map[string][]string `json:"webhookHeaders,omitempty"`
	// The (possibly) templated payload body, which is POSTed to the webhookUrl when invoked.
	WebhookPayload *string `json:"webhookPayload,omitempty"`
	// Only HTTPS is allowed.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}