model_create_webhook_request.go

/*
DocSpring API

Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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"
	"fmt"
)

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

// CreateWebhookRequest The webhook to create.
type CreateWebhookRequest struct {
	// A name for the webhook, shown in the dashboard.
	Name NullableString `json:"name,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// Headers to send with each request.
	Headers map[string]string `json:"headers,omitempty"`
}

type _CreateWebhookRequest CreateWebhookRequest

// NewCreateWebhookRequest instantiates a new CreateWebhookRequest 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 NewCreateWebhookRequest(url string, eventTypes []WebhookEventType) *CreateWebhookRequest {
	this := CreateWebhookRequest{}
	this.Url = url
	this.EventTypes = eventTypes
	return &this
}

// NewCreateWebhookRequestWithDefaults instantiates a new CreateWebhookRequest 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 NewCreateWebhookRequestWithDefaults() *CreateWebhookRequest {
	this := CreateWebhookRequest{}
	return &this
}

// GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *CreateWebhookRequest) GetName() string {
	if o == nil || IsNil(o.Name.Get()) {
		var ret string
		return ret
	}
	return *o.Name.Get()
}

// GetNameOk returns a tuple with the Name field value if set, nil otherwise
// 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 *CreateWebhookRequest) GetNameOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return o.Name.Get(), o.Name.IsSet()
}

// HasName returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasName() bool {
	if o != nil && o.Name.IsSet() {
		return true
	}

	return false
}

// SetName gets a reference to the given NullableString and assigns it to the Name field.
func (o *CreateWebhookRequest) SetName(v string) {
	o.Name.Set(&v)
}
// SetNameNil sets the value for Name to be an explicit nil
func (o *CreateWebhookRequest) SetNameNil() {
	o.Name.Set(nil)
}

// UnsetName ensures that no value is present for Name, not even an explicit nil
func (o *CreateWebhookRequest) UnsetName() {
	o.Name.Unset()
}

// GetUrl returns the Url field value
func (o *CreateWebhookRequest) 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 *CreateWebhookRequest) GetUrlOk() (*string, bool) {
	if o == nil {
		return nil, false
	}
	return &o.Url, true
}

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

// GetEnabled returns the Enabled field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetEnabled() bool {
	if o == nil || IsNil(o.Enabled) {
		var ret bool
		return ret
	}
	return *o.Enabled
}

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

// HasEnabled returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasEnabled() bool {
	if o != nil && !IsNil(o.Enabled) {
		return true
	}

	return false
}

// SetEnabled gets a reference to the given bool and assigns it to the Enabled field.
func (o *CreateWebhookRequest) SetEnabled(v bool) {
	o.Enabled = &v
}

// GetEventTypes returns the EventTypes field value
func (o *CreateWebhookRequest) 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 *CreateWebhookRequest) GetEventTypesOk() ([]WebhookEventType, bool) {
	if o == nil {
		return nil, false
	}
	return o.EventTypes, true
}

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

// GetMode returns the Mode field value if set, zero value otherwise (both if not set or set to explicit null).
func (o *CreateWebhookRequest) GetMode() WebhookMode {
	if o == nil || IsNil(o.Mode.Get()) {
		var ret WebhookMode
		return ret
	}
	return *o.Mode.Get()
}

// GetModeOk returns a tuple with the Mode field value if set, nil otherwise
// 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 *CreateWebhookRequest) GetModeOk() (*WebhookMode, bool) {
	if o == nil {
		return nil, false
	}
	return o.Mode.Get(), o.Mode.IsSet()
}

// HasMode returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasMode() bool {
	if o != nil && o.Mode.IsSet() {
		return true
	}

	return false
}

// SetMode gets a reference to the given NullableWebhookMode and assigns it to the Mode field.
func (o *CreateWebhookRequest) SetMode(v WebhookMode) {
	o.Mode.Set(&v)
}
// SetModeNil sets the value for Mode to be an explicit nil
func (o *CreateWebhookRequest) SetModeNil() {
	o.Mode.Set(nil)
}

// UnsetMode ensures that no value is present for Mode, not even an explicit nil
func (o *CreateWebhookRequest) UnsetMode() {
	o.Mode.Unset()
}

// GetApiTokenIds returns the ApiTokenIds field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetApiTokenIds() []string {
	if o == nil || IsNil(o.ApiTokenIds) {
		var ret []string
		return ret
	}
	return o.ApiTokenIds
}

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

// HasApiTokenIds returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasApiTokenIds() bool {
	if o != nil && !IsNil(o.ApiTokenIds) {
		return true
	}

	return false
}

// SetApiTokenIds gets a reference to the given []string and assigns it to the ApiTokenIds field.
func (o *CreateWebhookRequest) SetApiTokenIds(v []string) {
	o.ApiTokenIds = v
}

// GetTemplateIds returns the TemplateIds field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetTemplateIds() []string {
	if o == nil || IsNil(o.TemplateIds) {
		var ret []string
		return ret
	}
	return o.TemplateIds
}

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

// HasTemplateIds returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasTemplateIds() bool {
	if o != nil && !IsNil(o.TemplateIds) {
		return true
	}

	return false
}

// SetTemplateIds gets a reference to the given []string and assigns it to the TemplateIds field.
func (o *CreateWebhookRequest) SetTemplateIds(v []string) {
	o.TemplateIds = v
}

// GetFolderIds returns the FolderIds field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetFolderIds() []string {
	if o == nil || IsNil(o.FolderIds) {
		var ret []string
		return ret
	}
	return o.FolderIds
}

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

// HasFolderIds returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasFolderIds() bool {
	if o != nil && !IsNil(o.FolderIds) {
		return true
	}

	return false
}

// SetFolderIds gets a reference to the given []string and assigns it to the FolderIds field.
func (o *CreateWebhookRequest) SetFolderIds(v []string) {
	o.FolderIds = v
}

// GetIncludeSubmissionData returns the IncludeSubmissionData field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetIncludeSubmissionData() bool {
	if o == nil || IsNil(o.IncludeSubmissionData) {
		var ret bool
		return ret
	}
	return *o.IncludeSubmissionData
}

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

// HasIncludeSubmissionData returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasIncludeSubmissionData() bool {
	if o != nil && !IsNil(o.IncludeSubmissionData) {
		return true
	}

	return false
}

// SetIncludeSubmissionData gets a reference to the given bool and assigns it to the IncludeSubmissionData field.
func (o *CreateWebhookRequest) SetIncludeSubmissionData(v bool) {
	o.IncludeSubmissionData = &v
}

// GetStripFields returns the StripFields field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetStripFields() []string {
	if o == nil || IsNil(o.StripFields) {
		var ret []string
		return ret
	}
	return o.StripFields
}

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

// HasStripFields returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasStripFields() bool {
	if o != nil && !IsNil(o.StripFields) {
		return true
	}

	return false
}

// SetStripFields gets a reference to the given []string and assigns it to the StripFields field.
func (o *CreateWebhookRequest) SetStripFields(v []string) {
	o.StripFields = v
}

// GetHeaders returns the Headers field value if set, zero value otherwise.
func (o *CreateWebhookRequest) GetHeaders() map[string]string {
	if o == nil || IsNil(o.Headers) {
		var ret map[string]string
		return ret
	}
	return o.Headers
}

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

// HasHeaders returns a boolean if a field has been set.
func (o *CreateWebhookRequest) HasHeaders() bool {
	if o != nil && !IsNil(o.Headers) {
		return true
	}

	return false
}

// SetHeaders gets a reference to the given map[string]string and assigns it to the Headers field.
func (o *CreateWebhookRequest) SetHeaders(v map[string]string) {
	o.Headers = v
}

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

func (o CreateWebhookRequest) ToMap() (map[string]interface{}, error) {
	toSerialize := map[string]interface{}{}
	if o.Name.IsSet() {
		toSerialize["name"] = o.Name.Get()
	}
	toSerialize["url"] = o.Url
	if !IsNil(o.Enabled) {
		toSerialize["enabled"] = o.Enabled
	}
	toSerialize["event_types"] = o.EventTypes
	if o.Mode.IsSet() {
		toSerialize["mode"] = o.Mode.Get()
	}
	if !IsNil(o.ApiTokenIds) {
		toSerialize["api_token_ids"] = o.ApiTokenIds
	}
	if !IsNil(o.TemplateIds) {
		toSerialize["template_ids"] = o.TemplateIds
	}
	if !IsNil(o.FolderIds) {
		toSerialize["folder_ids"] = o.FolderIds
	}
	if !IsNil(o.IncludeSubmissionData) {
		toSerialize["include_submission_data"] = o.IncludeSubmissionData
	}
	if !IsNil(o.StripFields) {
		toSerialize["strip_fields"] = o.StripFields
	}
	if !IsNil(o.Headers) {
		toSerialize["headers"] = o.Headers
	}
	return toSerialize, nil
}

func (o *CreateWebhookRequest) 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{
		"url",
		"event_types",
	}

	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)
		}
	}

	varCreateWebhookRequest := _CreateWebhookRequest{}

	// Ignore unknown fields, so a field added to the API later doesn't break this client.
	err = json.Unmarshal(data, &varCreateWebhookRequest)

	if err != nil {
		return err
	}

	*o = CreateWebhookRequest(varCreateWebhookRequest)

	return err
}

type NullableCreateWebhookRequest struct {
	value *CreateWebhookRequest
	isSet bool
}

func (v NullableCreateWebhookRequest) Get() *CreateWebhookRequest {
	return v.value
}

func (v *NullableCreateWebhookRequest) Set(val *CreateWebhookRequest) {
	v.value = val
	v.isSet = true
}

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

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

func NewNullableCreateWebhookRequest(val *CreateWebhookRequest) *NullableCreateWebhookRequest {
	return &NullableCreateWebhookRequest{value: val, isSet: true}
}

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

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