Class: Zavudev::Models::Functions::GitLinkRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/functions/git_link_retrieve_response.rb,
sig/zavudev/models/functions/git_link_retrieve_response.rbs

Overview

See Also:

  • Zavudev::Resources::Functions::GitLink#retrieve

Defined Under Namespace

Classes: Link

Instance Attribute Summary collapse

Instance Method Summary collapse

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(link:, webhook_url:, webhook_secret: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Functions::GitLinkRetrieveResponse for more details.

`man

Parameters:

  • link (Zavudev::Models::Functions::GitLinkRetrieveResponse::Link) —

    A GitHub repository bound to a function. A push to branch deploys the function

  • webhook_url (String) —

    Endpoint that receives GitHub's push deliveries. Only needed on a manual link,

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

    Shared secret for the repository's webhook. **Returned only when creating a



# File 'lib/zavudev/models/functions/git_link_retrieve_response.rb', line 31

Instance Attribute Details

A GitHub repository bound to a function. A push to branch deploys the function. A function holds at most one link.



13
# File 'lib/zavudev/models/functions/git_link_retrieve_response.rb', line 13

required :link, -> { Zavudev::Models::Functions::GitLinkRetrieveResponse::Link }

#webhook_secret ⇒ String?

Shared secret for the repository's webhook. Returned only when creating a manual link, and only there — every later read strips it, and re-linking mints a new one. Absent entirely on an app link, which needs no secret of its own.

Parameters:

  • (String)

Returns:

  • (String, nil)


29
# File 'lib/zavudev/models/functions/git_link_retrieve_response.rb', line 29

optional :webhook_secret, String, api_name: :webhookSecret

#webhook_url ⇒ String

Endpoint that receives GitHub's push deliveries. Only needed on a manual link, where you add it to the repository yourself.

Parameters:

  • value (String)

Returns:

  • (String)


20
# File 'lib/zavudev/models/functions/git_link_retrieve_response.rb', line 20

required :webhook_url, String, api_name: :webhookUrl

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({)


26
# File 'sig/zavudev/models/functions/git_link_retrieve_response.rbs', line 26

def to_hash: -> {