Class: WhopSDK::Resources::AppBuilds

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/app_builds.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AppBuilds

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AppBuilds.

Parameters:



131
132
133
 
# File 'lib/whop_sdk/resources/app_builds.rb', line 131

def initialize(client:)
  @client = client
end

Instance Method Details

#create(attachment: , checksum: , platform: , app_id: nil, supported_app_view_types: nil, request_options: {}) ⇒ WhopSDK::Models::AppBuild

Some parameter documentations has been truncated, see Models::AppBuildCreateParams for more details.

Creates a new app build

Required permissions:

  • ‘developer:manage_builds`

Parameters:

  • attachment (WhopSDK::Models::AppBuildCreateParams::Attachment) —

    Attachment input for the app build file. This should be an upload in .zip format

  • checksum (String) —

    Checksum of the app build file. This is generated by the client and used to veri

  • platform (Symbol, WhopSDK::Models::AppBuildPlatforms) —

    The platform of the app build (ios, android, web)

  • app_id (String, nil) —

    The ID of the app to create a build for. By default the current app from the api

  • supported_app_view_types (Array<Symbol, WhopSDK::Models::AppViewType>, nil) —

    Supported app view types for the app build. A build can specify multiple view ty

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/whop_sdk/resources/app_builds.rb', line 32

def create(params)
  parsed, options = WhopSDK::AppBuildCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "app_builds",
    body: parsed,
    model: WhopSDK::AppBuild,
    options: options
  )
end

#list(app_id: , after: nil, before: nil, first: nil, last: nil, platform: nil, status: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::AppBuildListResponse>

Lists app builds for an app

Required permissions:

  • ‘developer:manage_builds`

Parameters:

  • app_id (String) —

    The ID of the app to filter app builds by

  • after (String, nil) —

    Returns the elements in the list that come after the specified cursor.

  • before (String, nil) —

    Returns the elements in the list that come before the specified cursor.

  • first (Integer, nil) —

    Returns the first n elements from the list.

  • last (Integer, nil) —

    Returns the last n elements from the list.

  • platform (Symbol, WhopSDK::Models::AppBuildPlatforms, nil) —

    The different platforms an app build can target.

  • status (Symbol, WhopSDK::Models::AppBuildStatuses, nil) —

    The different statuses an AppBuild can be in.

  • request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/whop_sdk/resources/app_builds.rb', line 93

def list(params)
  parsed, options = WhopSDK::AppBuildListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "app_builds",
    query: parsed,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::AppBuildListResponse,
    options: options
  )
end

#promote(id, request_options: {}) ⇒ WhopSDK::Models::AppBuild

Promotes an app build to production

Required permissions:

  • ‘developer:manage_builds`

Parameters:

Returns:

See Also:



119
120
121
122
123
124
125
126
 
# File 'lib/whop_sdk/resources/app_builds.rb', line 119

def promote(id, params = {})
  @client.request(
    method: :post,
    path: ["app_builds/%1$s/promote", id],
    model: WhopSDK::AppBuild,
    options: params[:request_options]
  )
end

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::AppBuild

Retrieves an app build by ID

Required permissions:

  • ‘developer:manage_builds`

Parameters:

Returns:

See Also:



57
58
59
60
61
62
63
64
 
# File 'lib/whop_sdk/resources/app_builds.rb', line 57

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["app_builds/%1$s", id],
    model: WhopSDK::AppBuild,
    options: params[:request_options]
  )
end