Class: OpenAI::Resources::Admin::Organization::Projects::SpendLimit

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/projects/spend_limit.rb,
sig/openai/resources/admin/organization/projects/spend_limit.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SpendLimit

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 SpendLimit.

Parameters:



87
88
89
 
# File 'lib/openai/resources/admin/organization/projects/spend_limit.rb', line 87

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(project_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimitDeleted

Delete a project's hard spend limit.

Parameters:

  • project_id (String) —

    The ID of the project whose hard spend limit is being managed.

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

Returns:

See Also:



74
75
76
77
78
79
80
81
82
 
# File 'lib/openai/resources/admin/organization/projects/spend_limit.rb', line 74

def delete(project_id, params = {})
  @client.request(
    method: :delete,
    path: ["organization/projects/%1$s/spend_limit", project_id],
    model: OpenAI::Admin::Organization::Projects::ProjectSpendLimitDeleted,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#retrieve(project_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit

Get a project's hard spend limit.

Parameters:

  • project_id (String) —

    The ID of the project whose hard spend limit is being managed.

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

Returns:

See Also:



20
21
22
23
24
25
26
27
28
 
# File 'lib/openai/resources/admin/organization/projects/spend_limit.rb', line 20

def retrieve(project_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/projects/%1$s/spend_limit", project_id],
    model: OpenAI::Admin::Organization::Projects::ProjectSpendLimit,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#update(project_id, currency:, interval:, threshold_amount:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectSpendLimit

Some parameter documentations has been truncated, see Models::Admin::Organization::Projects::SpendLimitUpdateParams for more details.

Create or replace a project's hard spend limit.

Parameters:

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/openai/resources/admin/organization/projects/spend_limit.rb', line 51

def update(project_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::SpendLimitUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s/spend_limit", project_id],
    body: parsed,
    model: OpenAI::Admin::Organization::Projects::ProjectSpendLimit,
    security: {admin_api_key_auth: true},
    options: options
  )
end