Class: Hook0::Generated::ApplicationsApi

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

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ApplicationsApi

Returns a new instance of ApplicationsApi.

Parameters:

  • transport (Object) —

    what one request is issued through



127
128
129
 
# File 'lib/hook0/generated/api.rb', line 127

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(body) ⇒ Application

Create a new application

Parameters:

Returns:



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/hook0/generated/api.rb', line 135

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

#delete(application_id) ⇒ void

This method returns an undefined value.

Delete an application

Parameters:

  • application_id (String) —

    carries application_id.



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/hook0/generated/api.rb', line 151

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

#get(application_id) ⇒ ApplicationInfo

Get an application by its ID

Parameters:

  • application_id (String) —

    carries application_id.

Returns:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/hook0/generated/api.rb', line 169

def get(application_id)
  read_answer(
    @transport.request(
      "GET",
      Runtime.path(
        "/api/v1/applications/{application_id}",
        "application_id" => application_id
      ),
      [],
      nil
    ),
    ApplicationInfo.method(:from_json)
  )
end

#list(organization_id) ⇒ Array<Application>

List applications

Parameters:

  • organization_id (String) —

    carries organization_id.

Returns:



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/hook0/generated/api.rb', line 188

def list(organization_id)
  read_answer(
    @transport.request(
      "GET",
      "/api/v1/applications/",
      Runtime.query(
        [
          ["organization_id", organization_id]
        ],
        []
      ),
      nil
    ),
    Runtime.list(Application.method(:from_json))
  )
end

#update(application_id, body) ⇒ Application

Edit an application

Parameters:

  • application_id (String) —

    carries application_id.

  • body (ApplicationPost) —

    what the operation reads

Returns:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/hook0/generated/api.rb', line 210

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