class PlatformAPI::ReviewApp

An ephemeral app to review a set of changes

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2732
def initialize(client)
  @client = client
end

Public Instance Methods

create(body = {}) click to toggle source

Create a new review app

@param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2739
def create(body = {})
  @client.review_app.create(body)
end
delete(review_app_id) click to toggle source

Delete an existing review app

@param review_app_id: unique identifier of the review app

# File lib/platform-api/client.rb, line 2753
def delete(review_app_id)
  @client.review_app.delete(review_app_id)
end
get_review_app(review_app_id) click to toggle source

Gets an existing review app

@param review_app_id: unique identifier of the review app

# File lib/platform-api/client.rb, line 2746
def get_review_app(review_app_id)
  @client.review_app.get_review_app(review_app_id)
end
get_review_app_by_app_id(app_id_or_app_name) click to toggle source

Get a review app using the associated app_id

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 2760
def get_review_app_by_app_id(app_id_or_app_name)
  @client.review_app.get_review_app_by_app_id(app_id_or_app_name)
end
list(pipeline_id) click to toggle source

List review apps for a pipeline

@param pipeline_id: unique identifier of pipeline

# File lib/platform-api/client.rb, line 2767
def list(pipeline_id)
  @client.review_app.list(pipeline_id)
end