Class: Hook0::Generated::ApplicationSecretsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hook0/generated/api.rb

Overview

What the API declares under applicationSecrets, issued through the transport it is handed.

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ApplicationSecretsApi

Returns a new instance of ApplicationSecretsApi.

Parameters:

  • transport (Object) —

    what one request is issued through



15
16
17
 
# File 'lib/hook0/generated/api.rb', line 15

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body) ⇒ ApplicationSecret

Create a new application secret

Parameters:

Returns:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/hook0/generated/api.rb', line 23

def create(body)
  read_answer(
    @transport.request(
      "POST",
      "/api/v1/application_secrets/",
      [],
      body.to_h
    ),
    ApplicationSecret.method(:from_json)
  )
end

#delete(application_secret_token, application_id) ⇒ void

This method returns an undefined value.

Delete an application secret

Parameters:

  • application_secret_token (String) —

    carries application_secret_token.

  • application_id (String) —

    carries application_id.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/hook0/generated/api.rb', line 40

def delete(application_secret_token, application_id)
  check_answer(
    @transport.request(
      "DELETE",
      Runtime.path(
        "/api/v1/application_secrets/{application_secret_token}",
        "application_secret_token" => application_secret_token
      ),
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        []
      ),
      nil
    )
  )
end

#read(application_id) ⇒ Array<ApplicationSecret>

List application secrets

Parameters:

  • application_id (String) —

    carries application_id.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/hook0/generated/api.rb', line 63

def read(application_id)
  read_answer(
    @transport.request(
      "GET",
      "/api/v1/application_secrets/",
      Runtime.query(
        [
          ["application_id", application_id]
        ],
        []
      ),
      nil
    ),
    Runtime.list(ApplicationSecret.method(:from_json))
  )
end

#update(application_secret_token, body) ⇒ ApplicationSecret

Update an application secret

Parameters:

  • application_secret_token (String) —

    carries application_secret_token.

  • body (ApplicationSecretPost) —

    what the operation reads

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/hook0/generated/api.rb', line 85

def update(application_secret_token, body)
  read_answer(
    @transport.request(
      "PUT",
      Runtime.path(
        "/api/v1/application_secrets/{application_secret_token}",
        "application_secret_token" => application_secret_token
      ),
      [],
      body.to_h
    ),
    ApplicationSecret.method(:from_json)
  )
end