Class: Whop_sdk::Users::Preferences::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/users/preferences/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



10
11
12
 
# File 'lib/whop_sdk/users/preferences/client.rb', line 10

def initialize(client:)
  @client = client
end

Instance Method Details

#notifications ⇒ Whop_sdk::Notifications::Client

Returns:



89
90
91
 
# File 'lib/whop_sdk/users/preferences/client.rb', line 89

def notifications
  @notifications ||= Whop_sdk::Users::Preferences::Notifications::Client.new(client: @client)
end

#retrieve(request_options: {}, **_params) ⇒ Whop_sdk::Types::UserPreferences

Retrieves the authenticated user's settings document. Addressed only as me — the document always belongs to the session user.

Examples:

client.users.preferences.retrieve

Parameters:

  • request_options (Hash) (defaults to: {})
  • _params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/whop_sdk/users/preferences/client.rb', line 29

def retrieve(request_options: {}, **_params)
  request = Whop_sdk::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "users/me/preferences",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Whop_sdk::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Whop_sdk::Types::UserPreferences.load(response.body)
  else
    error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#update(request_options: {}, **params) ⇒ Whop_sdk::Types::UserPreferences

Updates the authenticated user's settings document. Replaces the top-level keys it is given and leaves the rest untouched.

Examples:

client.users.preferences.update

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/whop_sdk/users/preferences/client.rb', line 65

def update(request_options: {}, **params)
  params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
  request = Whop_sdk::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "users/me/preferences",
    body: Whop_sdk::Users::Preferences::Types::UpdatePreferencesRequest.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Whop_sdk::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Whop_sdk::Types::UserPreferences.load(response.body)
  else
    error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end