model_webhook.go

/*
DocSpring API

Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.

API version: v2
*/

// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.

package docspring

import (
	"encoding/json"
	"time"
	"fmt"
)

// checks if the Webhook type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &Webhook{}

// Webhook An endpoint that DocSpring sends a POST request to when a subscribed event happens.
type Webhook struct {
	// The webhook's ID.
	Id string `json:"id"`
	// A name for the webhook, shown in the dashboard.
	Name NullableString `json:"name"`
	// The endpoint that receives webhook POST requests.
	Url string `json:"url"`
	// Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
	Enabled bool `json:"enabled"`
	// The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
	EventTypes []WebhookEventType `json:"event_types"`
	// Only send events for test or live submissions. Null sends both.
	Mode NullableWebhookMode `json:"mode"`
	// The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events.
	Version int32 `json:"version"`
	// Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
	ApiTokenIds []string `json:"api_token_ids"`
	// Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
	TemplateIds []string `json:"template_ids"`
	// Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
	FolderIds []string `json:"folder_ids"`
	// Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
	IncludeSubmissionData bool `json:"include_submission_data"`
	// Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
	StripFields []string `json:"strip_fields"`
	// Headers to send with each request.
	Headers map[string]string `json:"headers"`
	// How many deliveries in a row have failed.
	ConsecutiveFailures int32 `json:"consecutive_failures"`
	// When a delivery last failed.
	LastFailureAt NullableTime `json:"last_failure_at"`
	// When the webhook was disabled. Null while it is enabled.
	DisabledAt NullableTime `json:"disabled_at"`
	// Why the webhook was disabled, such as after repeated failures.
	DisabledReason NullableString `json:"disabled_reason"`
	// The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed.
	Secret NullableString `json:"secret"`
	// When the webhook was created.
	CreatedAt time.Time `json:"created_at"`
	// When the webhook was last updated.
	UpdatedAt time.Time `json:"updated_at"`
	AdditionalProperties map[string]interface{}
}

type _Webhook Webhook

// NewWebhook instantiates a new Webhook object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewWebhook(id string, name NullableString, url string, enabled bool, eventTypes []WebhookEventType, mode NullableWebhookMode, version int32, apiTokenIds []string, templateIds []string, folderIds []string, includeSubmissionData bool, stripFields []string, headers map[string]string, consecutiveFailures int32, lastFailureAt NullableTime, disabledAt NullableTime, disabledReason NullableString, secret NullableString, createdAt time.Time, updatedAt time.Time) *Webhook {
	this := Webhook{}
	this.Id = id
	this.Name = name
	this.Url = url
	this.Enabled = enabled
	this.EventTypes = eventTypes
	this.Mode = mode
	this.Version = version
	this.ApiTokenIds = apiTokenIds
	this.TemplateIds = templateIds
	this.FolderIds = folderIds
	this.IncludeSubmissionData = includeSubmissionData
	this.StripFields = stripFields
	this.Headers = headers
	this.ConsecutiveFailures = consecutiveFailures
	this.LastFailureAt = lastFailureAt
	this.DisabledAt = disabledAt
	this.DisabledReason = disabledReason
	this.Secret = secret
	this.CreatedAt = createdAt
	this.UpdatedAt = updatedAt
	return &this
}

// NewWebhookWithDefaults instantiates a new Webhook object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewWebhookWithDefaults() *Webhook {
	this := Webhook{}
	return &this
}

// GetId returns the Id field value
func (o *Webhook) GetId() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Id
}

// GetIdOk returns a tuple with the Id field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetIdOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Id, true
}

// SetId sets field value
func (o *Webhook) SetId(v string) {
	o.Id = v
}

// GetName returns the Name field value
// If the value is explicit nil, the zero value for string will be returned
func (o *Webhook) GetName() string {
	if o == nil || o.Name.Get() == nil {
		var ret string
		return ret
	}

	return *o.Name.Get()
}

// GetNameOk returns a tuple with the Name field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetNameOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Name.Get(), o.Name.IsSet()
}

// SetName sets field value
func (o *Webhook) SetName(v string) {
	o.Name.Set(&v)
}

// GetUrl returns the Url field value
func (o *Webhook) GetUrl() string {
	if o == nil {
		var ret string
		return ret
	}

	return o.Url
}

// GetUrlOk returns a tuple with the Url field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetUrlOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Url, true
}

// SetUrl sets field value
func (o *Webhook) SetUrl(v string) {
	o.Url = v
}

// GetEnabled returns the Enabled field value
func (o *Webhook) GetEnabled() bool {
	if o == nil {
		var ret bool
		return ret
	}

	return o.Enabled
}

// GetEnabledOk returns a tuple with the Enabled field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetEnabledOk() (*bool, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Enabled, true
}

// SetEnabled sets field value
func (o *Webhook) SetEnabled(v bool) {
	o.Enabled = v
}

// GetEventTypes returns the EventTypes field value
func (o *Webhook) GetEventTypes() []WebhookEventType {
	if o == nil {
		var ret []WebhookEventType
		return ret
	}

	return o.EventTypes
}

// GetEventTypesOk returns a tuple with the EventTypes field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetEventTypesOk() ([]WebhookEventType, bool) {
	if o == nil {
		return nil, false
	}
	return o.EventTypes, true
}

// SetEventTypes sets field value
func (o *Webhook) SetEventTypes(v []WebhookEventType) {
	o.EventTypes = v
}

// GetMode returns the Mode field value
// If the value is explicit nil, the zero value for WebhookMode will be returned
func (o *Webhook) GetMode() WebhookMode {
	if o == nil || o.Mode.Get() == nil {
		var ret WebhookMode
		return ret
	}

	return *o.Mode.Get()
}

// GetModeOk returns a tuple with the Mode field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetModeOk() (*WebhookMode, bool) {
	if o == nil {
		return nil, false
	}
	return o.Mode.Get(), o.Mode.IsSet()
}

// SetMode sets field value
func (o *Webhook) SetMode(v WebhookMode) {
	o.Mode.Set(&v)
}

// GetVersion returns the Version field value
func (o *Webhook) GetVersion() int32 {
	if o == nil {
		var ret int32
		return ret
	}

	return o.Version
}

// GetVersionOk returns a tuple with the Version field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetVersionOk() (*int32, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Version, true
}

// SetVersion sets field value
func (o *Webhook) SetVersion(v int32) {
	o.Version = v
}

// GetApiTokenIds returns the ApiTokenIds field value
func (o *Webhook) GetApiTokenIds() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.ApiTokenIds
}

// GetApiTokenIdsOk returns a tuple with the ApiTokenIds field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetApiTokenIdsOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.ApiTokenIds, true
}

// SetApiTokenIds sets field value
func (o *Webhook) SetApiTokenIds(v []string) {
	o.ApiTokenIds = v
}

// GetTemplateIds returns the TemplateIds field value
func (o *Webhook) GetTemplateIds() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.TemplateIds
}

// GetTemplateIdsOk returns a tuple with the TemplateIds field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetTemplateIdsOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.TemplateIds, true
}

// SetTemplateIds sets field value
func (o *Webhook) SetTemplateIds(v []string) {
	o.TemplateIds = v
}

// GetFolderIds returns the FolderIds field value
func (o *Webhook) GetFolderIds() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.FolderIds
}

// GetFolderIdsOk returns a tuple with the FolderIds field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetFolderIdsOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.FolderIds, true
}

// SetFolderIds sets field value
func (o *Webhook) SetFolderIds(v []string) {
	o.FolderIds = v
}

// GetIncludeSubmissionData returns the IncludeSubmissionData field value
func (o *Webhook) GetIncludeSubmissionData() bool {
	if o == nil {
		var ret bool
		return ret
	}

	return o.IncludeSubmissionData
}

// GetIncludeSubmissionDataOk returns a tuple with the IncludeSubmissionData field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetIncludeSubmissionDataOk() (*bool, bool) {
	if o == nil {
		return nil, false
	}
	return &o.IncludeSubmissionData, true
}

// SetIncludeSubmissionData sets field value
func (o *Webhook) SetIncludeSubmissionData(v bool) {
	o.IncludeSubmissionData = v
}

// GetStripFields returns the StripFields field value
func (o *Webhook) GetStripFields() []string {
	if o == nil {
		var ret []string
		return ret
	}

	return o.StripFields
}

// GetStripFieldsOk returns a tuple with the StripFields field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetStripFieldsOk() ([]string, bool) {
	if o == nil {
		return nil, false
	}
	return o.StripFields, true
}

// SetStripFields sets field value
func (o *Webhook) SetStripFields(v []string) {
	o.StripFields = v
}

// GetHeaders returns the Headers field value
func (o *Webhook) GetHeaders() map[string]string {
	if o == nil {
		var ret map[string]string
		return ret
	}

	return o.Headers
}

// GetHeadersOk returns a tuple with the Headers field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetHeadersOk() (map[string]string, bool) {
	if o == nil {
		return map[string]string{}, false
	}
	return o.Headers, true
}

// SetHeaders sets field value
func (o *Webhook) SetHeaders(v map[string]string) {
	o.Headers = v
}

// GetConsecutiveFailures returns the ConsecutiveFailures field value
func (o *Webhook) GetConsecutiveFailures() int32 {
	if o == nil {
		var ret int32
		return ret
	}

	return o.ConsecutiveFailures
}

// GetConsecutiveFailuresOk returns a tuple with the ConsecutiveFailures field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetConsecutiveFailuresOk() (*int32, bool) {
	if o == nil {
		return nil, false
	}
	return &o.ConsecutiveFailures, true
}

// SetConsecutiveFailures sets field value
func (o *Webhook) SetConsecutiveFailures(v int32) {
	o.ConsecutiveFailures = v
}

// GetLastFailureAt returns the LastFailureAt field value
// If the value is explicit nil, the zero value for time.Time will be returned
func (o *Webhook) GetLastFailureAt() time.Time {
	if o == nil || o.LastFailureAt.Get() == nil {
		var ret time.Time
		return ret
	}

	return *o.LastFailureAt.Get()
}

// GetLastFailureAtOk returns a tuple with the LastFailureAt field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetLastFailureAtOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return o.LastFailureAt.Get(), o.LastFailureAt.IsSet()
}

// SetLastFailureAt sets field value
func (o *Webhook) SetLastFailureAt(v time.Time) {
	o.LastFailureAt.Set(&v)
}

// GetDisabledAt returns the DisabledAt field value
// If the value is explicit nil, the zero value for time.Time will be returned
func (o *Webhook) GetDisabledAt() time.Time {
	if o == nil || o.DisabledAt.Get() == nil {
		var ret time.Time
		return ret
	}

	return *o.DisabledAt.Get()
}

// GetDisabledAtOk returns a tuple with the DisabledAt field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetDisabledAtOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return o.DisabledAt.Get(), o.DisabledAt.IsSet()
}

// SetDisabledAt sets field value
func (o *Webhook) SetDisabledAt(v time.Time) {
	o.DisabledAt.Set(&v)
}

// GetDisabledReason returns the DisabledReason field value
// If the value is explicit nil, the zero value for string will be returned
func (o *Webhook) GetDisabledReason() string {
	if o == nil || o.DisabledReason.Get() == nil {
		var ret string
		return ret
	}

	return *o.DisabledReason.Get()
}

// GetDisabledReasonOk returns a tuple with the DisabledReason field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetDisabledReasonOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.DisabledReason.Get(), o.DisabledReason.IsSet()
}

// SetDisabledReason sets field value
func (o *Webhook) SetDisabledReason(v string) {
	o.DisabledReason.Set(&v)
}

// GetSecret returns the Secret field value
// If the value is explicit nil, the zero value for string will be returned
func (o *Webhook) GetSecret() string {
	if o == nil || o.Secret.Get() == nil {
		var ret string
		return ret
	}

	return *o.Secret.Get()
}

// GetSecretOk returns a tuple with the Secret field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *Webhook) GetSecretOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Secret.Get(), o.Secret.IsSet()
}

// SetSecret sets field value
func (o *Webhook) SetSecret(v string) {
	o.Secret.Set(&v)
}

// GetCreatedAt returns the CreatedAt field value
func (o *Webhook) GetCreatedAt() time.Time {
	if o == nil {
		var ret time.Time
		return ret
	}

	return o.CreatedAt
}

// GetCreatedAtOk returns a tuple with the CreatedAt field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetCreatedAtOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return &o.CreatedAt, true
}

// SetCreatedAt sets field value
func (o *Webhook) SetCreatedAt(v time.Time) {
	o.CreatedAt = v
}

// GetUpdatedAt returns the UpdatedAt field value
func (o *Webhook) GetUpdatedAt() time.Time {
	if o == nil {
		var ret time.Time
		return ret
	}

	return o.UpdatedAt
}

// GetUpdatedAtOk returns a tuple with the UpdatedAt field value
// and a boolean to check if the value has been set.
func (o *Webhook) GetUpdatedAtOk() (*time.Time, bool) {
	if o == nil {
		return nil, false
	}
	return &o.UpdatedAt, true
}

// SetUpdatedAt sets field value
func (o *Webhook) SetUpdatedAt(v time.Time) {
	o.UpdatedAt = v
}

func (o Webhook) MarshalJSON() ([]byte, error) {
	toSerialize,err := o.ToMap()
	if err != nil {
		return []byte{}, err
	}
	return json.Marshal(toSerialize)
}

func (o Webhook) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	toSerialize["id"] = o.Id
	toSerialize["name"] = o.Name.Get()
	toSerialize["url"] = o.Url
	toSerialize["enabled"] = o.Enabled
	toSerialize["event_types"] = o.EventTypes
	toSerialize["mode"] = o.Mode.Get()
	toSerialize["version"] = o.Version
	toSerialize["api_token_ids"] = o.ApiTokenIds
	toSerialize["template_ids"] = o.TemplateIds
	toSerialize["folder_ids"] = o.FolderIds
	toSerialize["include_submission_data"] = o.IncludeSubmissionData
	toSerialize["strip_fields"] = o.StripFields
	toSerialize["headers"] = o.Headers
	toSerialize["consecutive_failures"] = o.ConsecutiveFailures
	toSerialize["last_failure_at"] = o.LastFailureAt.Get()
	toSerialize["disabled_at"] = o.DisabledAt.Get()
	toSerialize["disabled_reason"] = o.DisabledReason.Get()
	toSerialize["secret"] = o.Secret.Get()
	toSerialize["created_at"] = o.CreatedAt
	toSerialize["updated_at"] = o.UpdatedAt

	for key, value := range o.AdditionalProperties {
		toSerialize[key] = value
	}

	return toSerialize, nil
}

func (o *Webhook) UnmarshalJSON(data []byte) (err error) {
	// This validates that all required properties are included in the JSON object
	// by unmarshalling the object into a generic map with string keys and checking
	// that every required field exists as a key in the generic map.
	requiredProperties := []string{
		"id",
		"name",
		"url",
		"enabled",
		"event_types",
		"mode",
		"version",
		"api_token_ids",
		"template_ids",
		"folder_ids",
		"include_submission_data",
		"strip_fields",
		"headers",
		"consecutive_failures",
		"last_failure_at",
		"disabled_at",
		"disabled_reason",
		"secret",
		"created_at",
		"updated_at",
	}

	allProperties := make(map[string]interface{})

	err = json.Unmarshal(data, &allProperties)

	if err != nil {
		return err;
	}

	for _, requiredProperty := range(requiredProperties) {
		if _, exists := allProperties[requiredProperty]; !exists {
			return fmt.Errorf("no value given for required property %v", requiredProperty)
		}
	}

	varWebhook := _Webhook{}

	err = json.Unmarshal(data, &varWebhook)

	if err != nil {
		return err
	}

	*o = Webhook(varWebhook)

	additionalProperties := make(map[string]interface{})

	if err = json.Unmarshal(data, &additionalProperties); err == nil {
		delete(additionalProperties, "id")
		delete(additionalProperties, "name")
		delete(additionalProperties, "url")
		delete(additionalProperties, "enabled")
		delete(additionalProperties, "event_types")
		delete(additionalProperties, "mode")
		delete(additionalProperties, "version")
		delete(additionalProperties, "api_token_ids")
		delete(additionalProperties, "template_ids")
		delete(additionalProperties, "folder_ids")
		delete(additionalProperties, "include_submission_data")
		delete(additionalProperties, "strip_fields")
		delete(additionalProperties, "headers")
		delete(additionalProperties, "consecutive_failures")
		delete(additionalProperties, "last_failure_at")
		delete(additionalProperties, "disabled_at")
		delete(additionalProperties, "disabled_reason")
		delete(additionalProperties, "secret")
		delete(additionalProperties, "created_at")
		delete(additionalProperties, "updated_at")
		o.AdditionalProperties = additionalProperties
	}

	return err
}

type NullableWebhook struct {
	value *Webhook
	isSet bool
}

func (v NullableWebhook) Get() *Webhook {
	return v.value
}

func (v *NullableWebhook) Set(val *Webhook) {
	v.value = val
	v.isSet = true
}

func (v NullableWebhook) IsSet() bool {
	return v.isSet
}

func (v *NullableWebhook) Unset() {
	v.value = nil
	v.isSet = false
}

func NewNullableWebhook(val *Webhook) *NullableWebhook {
	return &NullableWebhook{value: val, isSet: true}
}

func (v NullableWebhook) MarshalJSON() ([]byte, error) {
	return json.Marshal(v.value)
}

func (v *NullableWebhook) UnmarshalJSON(src []byte) error {
	v.isSet = true
	return json.Unmarshal(src, &v.value)
}