Class: SignwellSDK::Models::V1::HookCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/signwell_sdk/models/v1/hook_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(callback_url:, api_application_id: nil, request_options: {}) ⇒ Object

Parameters:

  • callback_url (String) —

    URL that we will post document events to.

  • api_application_id (String) (defaults to: nil) —

    Unique identifier for the API Application.

  • request_options (SignwellSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/signwell_sdk/models/v1/hook_create_params.rb', line 23

Instance Attribute Details

#api_application_id ⇒ String?

Unique identifier for the API Application.

Returns:

  • (String, nil) 


21
 
# File 'lib/signwell_sdk/models/v1/hook_create_params.rb', line 21

optional :api_application_id, String

#callback_url ⇒ String

URL that we will post document events to.

Returns:

  • (String) 


15
 
# File 'lib/signwell_sdk/models/v1/hook_create_params.rb', line 15

required :callback_url, String