Class: Fizzy::Services::MiscellaneousService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/fizzy/generated/services/miscellaneous_service.rb

Overview

Service for Miscellaneous operations

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

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

Instance Method Details

#create_access_token(description:, permission:) ⇒ Hash

create_access_token operation

Parameters:

  • description (String) —

    description

  • permission (String) —

    permission

Returns:

  • (Hash) —

    response data



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

def create_access_token(description:, permission:)
  with_operation(service: "miscellaneous", operation: "CreateAccessToken", is_mutation: true) do
    http_post("/my/access_tokens.json", body: compact_params(description: description, permission: permission)).json
  end
end

#create_account_export(account_id:) ⇒ Hash

create_account_export operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Hash) —

    response data



51
52
53
54
55
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 51

def (account_id:)
  with_operation(service: "miscellaneous", operation: "CreateAccountExport", is_mutation: true, resource_id: ) do
    http_post("/#{}/account/exports.json").json
  end
end

#create_push_subscription(account_id:, user_id:, endpoint:, p256dh_key:, auth_key:) ⇒ void

This method returns an undefined value.

create_push_subscription operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • endpoint (String) —

    endpoint

  • p256dh_key (String) —

    p256dh key

  • auth_key (String) —

    auth key



222
223
224
225
226
227
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 222

def create_push_subscription(account_id:, user_id:, endpoint:, p256dh_key:, auth_key:)
  with_operation(service: "miscellaneous", operation: "CreatePushSubscription", is_mutation: true, resource_id: user_id) do
    http_post("/#{}/users/#{user_id}/push_subscriptions.json", body: compact_params(endpoint: endpoint, p256dh_key: p256dh_key, auth_key: auth_key))
    nil
  end
end

#delete_access_token(access_token_id:) ⇒ void

This method returns an undefined value.

delete_access_token operation

Parameters:

  • access_token_id (String) —

    access token id ID



31
32
33
34
35
36
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 31

def delete_access_token(access_token_id:)
  with_operation(service: "miscellaneous", operation: "DeleteAccessToken", is_mutation: true, resource_id: access_token_id) do
    http_delete("/my/access_tokens/#{access_token_id}")
    nil
  end
end

#delete_push_subscription(account_id:, user_id:, push_subscription_id:) ⇒ void

This method returns an undefined value.

delete_push_subscription operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • push_subscription_id (String) —

    push subscription id ID



234
235
236
237
238
239
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 234

def delete_push_subscription(account_id:, user_id:, push_subscription_id:)
  with_operation(service: "miscellaneous", operation: "DeletePushSubscription", is_mutation: true, resource_id: push_subscription_id) do
    http_delete("/#{}/users/#{user_id}/push_subscriptions/#{push_subscription_id}")
    nil
  end
end

#delete_user_avatar(account_id:, user_id:) ⇒ void

This method returns an undefined value.

delete_user_avatar operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID



208
209
210
211
212
213
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 208

def delete_user_avatar(account_id:, user_id:)
  with_operation(service: "miscellaneous", operation: "DeleteUserAvatar", is_mutation: true, resource_id: user_id) do
    http_delete("/#{}/users/#{user_id}/avatar")
    nil
  end
end

#get_account_export(account_id:, export_id:) ⇒ Hash

get_account_export operation

Parameters:

  • account_id (String) —

    account id ID

  • export_id (String) —

    export id ID

Returns:

  • (Hash) —

    response data



61
62
63
64
65
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 61

def (account_id:, export_id:)
  with_operation(service: "miscellaneous", operation: "GetAccountExport", is_mutation: false, resource_id: export_id) do
    http_get("/#{}/account/exports/#{export_id}").json
  end
end

#get_account_settings(account_id:) ⇒ Hash

get_account_settings operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Hash) —

    response data



100
101
102
103
104
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 100

def (account_id:)
  with_operation(service: "miscellaneous", operation: "GetAccountSettings", is_mutation: false, resource_id: ) do
    http_get("/#{}/account/settings.json").json
  end
end

#get_join_code(account_id:) ⇒ Hash

get_join_code operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Hash) —

    response data



70
71
72
73
74
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 70

def get_join_code(account_id:)
  with_operation(service: "miscellaneous", operation: "GetJoinCode", is_mutation: false, resource_id: ) do
    http_get("/#{}/account/join_code.json").json
  end
end

#get_notification_settings(account_id:) ⇒ Hash

get_notification_settings operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Hash) —

    response data



187
188
189
190
191
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 187

def get_notification_settings(account_id:)
  with_operation(service: "miscellaneous", operation: "GetNotificationSettings", is_mutation: false, resource_id: ) do
    http_get("/#{}/notifications/settings.json").json
  end
end

#list_access_tokens ⇒ Hash

list_access_tokens operation

Returns:

  • (Hash) —

    response data



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

def list_access_tokens()
  with_operation(service: "miscellaneous", operation: "ListAccessTokens", is_mutation: false) do
    http_get("/my/access_tokens.json").json
  end
end

#mark_card_read(account_id:, card_number:) ⇒ void

This method returns an undefined value.

mark_card_read operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



144
145
146
147
148
149
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 144

def mark_card_read(account_id:, card_number:)
  with_operation(service: "miscellaneous", operation: "MarkCardRead", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/reading.json", retryable: true)
    nil
  end
end

#mark_card_unread(account_id:, card_number:) ⇒ void

This method returns an undefined value.

mark_card_unread operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



155
156
157
158
159
160
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 155

def mark_card_unread(account_id:, card_number:)
  with_operation(service: "miscellaneous", operation: "MarkCardUnread", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/reading.json")
    nil
  end
end

#move_column_left(account_id:, column_id:) ⇒ void

This method returns an undefined value.

move_column_left operation

Parameters:

  • account_id (String) —

    account id ID

  • column_id (String) —

    column id ID



166
167
168
169
170
171
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 166

def move_column_left(account_id:, column_id:)
  with_operation(service: "miscellaneous", operation: "MoveColumnLeft", is_mutation: true, resource_id: column_id) do
    http_post("/#{}/columns/#{column_id}/left_position.json", retryable: true)
    nil
  end
end

#move_column_right(account_id:, column_id:) ⇒ void

This method returns an undefined value.

move_column_right operation

Parameters:

  • account_id (String) —

    account id ID

  • column_id (String) —

    column id ID



177
178
179
180
181
182
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 177

def move_column_right(account_id:, column_id:)
  with_operation(service: "miscellaneous", operation: "MoveColumnRight", is_mutation: true, resource_id: column_id) do
    http_post("/#{}/columns/#{column_id}/right_position.json", retryable: true)
    nil
  end
end

#reset_join_code(account_id:) ⇒ void

This method returns an undefined value.

reset_join_code operation

Parameters:

  • account_id (String) —

    account id ID



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

def reset_join_code(account_id:)
  with_operation(service: "miscellaneous", operation: "ResetJoinCode", is_mutation: true, resource_id: ) do
    http_delete("/#{}/account/join_code.json")
    nil
  end
end

#update_account_entropy(account_id:, auto_postpone_period_in_days: nil) ⇒ Hash

update_account_entropy operation

Parameters:

  • account_id (String) —

    account id ID

  • auto_postpone_period_in_days (Integer, nil) (defaults to: nil) —

    auto postpone period in days

Returns:

  • (Hash) —

    response data



42
43
44
45
46
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 42

def (account_id:, auto_postpone_period_in_days: nil)
  with_operation(service: "miscellaneous", operation: "UpdateAccountEntropy", is_mutation: true, resource_id: ) do
    http_put("/#{}/account/entropy.json", body: compact_params(auto_postpone_period_in_days: auto_postpone_period_in_days)).json
  end
end

#update_account_settings(account_id:, name: nil) ⇒ void

This method returns an undefined value.

update_account_settings operation

Parameters:

  • account_id (String) —

    account id ID

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

    name



110
111
112
113
114
115
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 110

def (account_id:, name: nil)
  with_operation(service: "miscellaneous", operation: "UpdateAccountSettings", is_mutation: true, resource_id: ) do
    http_patch("/#{}/account/settings.json", body: compact_params(name: name))
    nil
  end
end

#update_board_entropy(account_id:, board_id:, auto_postpone_period_in_days: nil) ⇒ Hash

update_board_entropy operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

  • auto_postpone_period_in_days (Integer, nil) (defaults to: nil) —

    auto postpone period in days

Returns:

  • (Hash) —

    response data



122
123
124
125
126
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 122

def update_board_entropy(account_id:, board_id:, auto_postpone_period_in_days: nil)
  with_operation(service: "miscellaneous", operation: "UpdateBoardEntropy", is_mutation: true, resource_id: board_id) do
    http_put("/#{}/boards/#{board_id}/entropy.json", body: compact_params(auto_postpone_period_in_days: auto_postpone_period_in_days)).json
  end
end

#update_board_involvement(account_id:, board_id:, involvement: nil) ⇒ void

This method returns an undefined value.

update_board_involvement operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

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

    involvement



133
134
135
136
137
138
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 133

def update_board_involvement(account_id:, board_id:, involvement: nil)
  with_operation(service: "miscellaneous", operation: "UpdateBoardInvolvement", is_mutation: true, resource_id: board_id) do
    http_patch("/#{}/boards/#{board_id}/involvement.json", body: compact_params(involvement: involvement))
    nil
  end
end

#update_join_code(account_id:, usage_limit: nil) ⇒ void

This method returns an undefined value.

update_join_code operation

Parameters:

  • account_id (String) —

    account id ID

  • usage_limit (Integer, nil) (defaults to: nil) —

    usage limit



80
81
82
83
84
85
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 80

def update_join_code(account_id:, usage_limit: nil)
  with_operation(service: "miscellaneous", operation: "UpdateJoinCode", is_mutation: true, resource_id: ) do
    http_patch("/#{}/account/join_code.json", body: compact_params(usage_limit: usage_limit))
    nil
  end
end

#update_notification_settings(account_id:, bundle_email_frequency: nil) ⇒ void

This method returns an undefined value.

update_notification_settings operation

Parameters:

  • account_id (String) —

    account id ID

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

    bundle email frequency



197
198
199
200
201
202
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 197

def update_notification_settings(account_id:, bundle_email_frequency: nil)
  with_operation(service: "miscellaneous", operation: "UpdateNotificationSettings", is_mutation: true, resource_id: ) do
    http_patch("/#{}/notifications/settings.json", body: compact_params(bundle_email_frequency: bundle_email_frequency))
    nil
  end
end

#update_user_role(account_id:, user_id:, role:) ⇒ void

This method returns an undefined value.

update_user_role operation

Parameters:

  • account_id (String) —

    account id ID

  • user_id (String) —

    user id ID

  • role (String) —

    role



246
247
248
249
250
251
 
# File 'lib/fizzy/generated/services/miscellaneous_service.rb', line 246

def update_user_role(account_id:, user_id:, role:)
  with_operation(service: "miscellaneous", operation: "UpdateUserRole", is_mutation: true, resource_id: user_id) do
    http_patch("/#{}/users/#{user_id}/role.json", body: compact_params(role: role))
    nil
  end
end