Class: TrophyApiClient::Admin::Streaks::AsyncFreezesClient

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::AsyncFreezesClient 



59
60
61
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 59

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::AsyncRequestClient (readonly) 



55
56
57
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 55

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" }])



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/trophy_api_client/admin/streaks/freezes/client.rb', line 76

def create(freezes:, request_options: nil)
  Async do
    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
end