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

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/spend_limit.rb,
sig/openai/resources/admin/organization/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:



79
80
81
 
# File 'lib/openai/resources/admin/organization/spend_limit.rb', line 79

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationSpendLimitDeleted

Delete the organization's hard spend limit.

Parameters:

Returns:

See Also:



66
67
68
69
70
71
72
73
74
 
# File 'lib/openai/resources/admin/organization/spend_limit.rb', line 66

def delete(params = {})
  @client.request(
    method: :delete,
    path: "organization/spend_limit",
    model: OpenAI::Admin::Organization::OrganizationSpendLimitDeleted,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#retrieve(request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationSpendLimit

Get the organization's hard spend limit.

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
25
 
# File 'lib/openai/resources/admin/organization/spend_limit.rb', line 17

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "organization/spend_limit",
    model: OpenAI::Admin::Organization::OrganizationSpendLimit,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

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

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

Create or replace the organization's hard spend limit.

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/openai/resources/admin/organization/spend_limit.rb', line 45

def update(params)
  parsed, options = OpenAI::Admin::Organization::SpendLimitUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/spend_limit",
    body: parsed,
    model: OpenAI::Admin::Organization::OrganizationSpendLimit,
    security: {admin_api_key_auth: true},
    options: options
  )
end