Class: Fizzy::Services::UsersService

Inherits:
BaseService show all
Defined in:
lib/fizzy/generated/services/users_service.rb

Overview

Service for Users operations

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Fizzy::Services::BaseService

Instance Method Details

#confirm_email_address_change(account_id:, user_id:, email_address_token:) ⇒ void

This method returns an undefined value.

confirm_email_address_change operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • email_address_token (String) —

    email address token ID



89
90
91
92
93
94
 
# File 'lib/fizzy/generated/services/users_service.rb', line 89

def confirm_email_address_change(account_id:, user_id:, email_address_token:)
  with_operation(service: "users", operation: "ConfirmEmailAddressChange", is_mutation: true, resource_id: email_address_token) do
    http_post("/#{}/users/#{user_id}/email_addresses/#{email_address_token}/confirmation.json")
    nil
  end
end

#create_user_data_export(account_id:, user_id:) ⇒ Hash

create_user_data_export operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

Returns:

  • (Hash) —

    response data



55
56
57
58
59
 
# File 'lib/fizzy/generated/services/users_service.rb', line 55

def create_user_data_export(account_id:, user_id:)
  with_operation(service: "users", operation: "CreateUserDataExport", is_mutation: true, resource_id: user_id) do
    http_post("/#{}/users/#{user_id}/data_exports.json").json
  end
end

#deactivate(account_id:, user_id:) ⇒ void

This method returns an undefined value.

deactivate operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID



44
45
46
47
48
49
 
# File 'lib/fizzy/generated/services/users_service.rb', line 44

def deactivate(account_id:, user_id:)
  with_operation(service: "users", operation: "DeactivateUser", is_mutation: true, resource_id: user_id) do
    http_delete("/#{}/users/#{user_id}")
    nil
  end
end

#get(account_id:, user_id:) ⇒ Hash

get operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

Returns:

  • (Hash) —

    response data



23
24
25
26
27
 
# File 'lib/fizzy/generated/services/users_service.rb', line 23

def get(account_id:, user_id:)
  with_operation(service: "users", operation: "GetUser", is_mutation: false, resource_id: user_id) do
    http_get("/#{}/users/#{user_id}").json
  end
end

#get_user_data_export(account_id:, user_id:, export_id:) ⇒ Hash

get_user_data_export operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • export_id (String) —

    export id ID

Returns:

  • (Hash) —

    response data



66
67
68
69
70
 
# File 'lib/fizzy/generated/services/users_service.rb', line 66

def get_user_data_export(account_id:, user_id:, export_id:)
  with_operation(service: "users", operation: "GetUserDataExport", is_mutation: false, resource_id: export_id) do
    http_get("/#{}/users/#{user_id}/data_exports/#{export_id}").json
  end
end

#list(account_id:) ⇒ Enumerator<Hash>

list operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



13
14
15
16
17
 
# File 'lib/fizzy/generated/services/users_service.rb', line 13

def list(account_id:)
  wrap_paginated(service: "users", operation: "ListUsers", is_mutation: false, resource_id: ) do
    paginate("/#{}/users.json")
  end
end

#request_email_address_change(account_id:, user_id:, email_address:) ⇒ void

This method returns an undefined value.

request_email_address_change operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • email_address (String) —

    email address



77
78
79
80
81
82
 
# File 'lib/fizzy/generated/services/users_service.rb', line 77

def request_email_address_change(account_id:, user_id:, email_address:)
  with_operation(service: "users", operation: "RequestEmailAddressChange", is_mutation: true, resource_id: user_id) do
    http_post("/#{}/users/#{user_id}/email_addresses.json", body: compact_params(email_address: email_address))
    nil
  end
end

#update(account_id:, user_id:, name: nil) ⇒ Hash

update operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • name (String, nil) (defaults to: nil) —

    name

Returns:

  • (Hash) —

    response data



34
35
36
37
38
 
# File 'lib/fizzy/generated/services/users_service.rb', line 34

def update(account_id:, user_id:, name: nil)
  with_operation(service: "users", operation: "UpdateUser", is_mutation: true, resource_id: user_id) do
    http_patch("/#{}/users/#{user_id}", body: compact_params(name: name)).json
  end
end