Class: TrophyApiClient::Admin::Streaks::FreezesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/admin/streaks/freezes/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ TrophyApiClient::Admin::Streaks::FreezesClient

Parameters:



17
18
19
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#create(freezes:, request_options: nil) ⇒ TrophyApiClient::CreateStreakFreezesResponse

Create streak freezes for multiple users.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.admin.streaks.freezes.create(freezes: [{ user_id: "user-123" }, { user_id: "user-456" }, { user_id: "user-123" }])

Parameters:

  • freezes (Array<Hash>) —

    Array of freezes to create. Maximum 1,000 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash

    • :user_id (String)

  • request_options (TrophyApiClient::RequestOptions) (defaults to: nil)

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 34

def create(freezes:, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request_options&.additional_body_parameters || {}), freezes: freezes }.compact
    req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/freezes"
  end
  TrophyApiClient::CreateStreakFreezesResponse.from_json(json_object: response.body)
end