client.account
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
The account of the person behind the key or the app: the email notifications they get and the workspaces muted on their phone, their profile photo and username, the apps they connected and the invitations waiting for them. An API key acts for the workspace owner, and an app for the person who connected it.
account.get_notifications
Read your notification settings
get_notifications(api_key: nil) -> HashReturns which kinds of email OpenEmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. An API key answers for the workspace owner, and an app for the person who connected it.
Параметры
api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with email, an Array with one Hash for each kind of email, each with category, label, description, required and enabled, and mutedWorkspaces.
Пример
settings = client.account.get_notifications settings[:email].each { |kind| puts "#{kind[:label]} #{kind[:enabled]}" }Примечания
accountandbillingemail are always on, andrequiredsays so.
Также доступно в
account.set_email_notification
Turn a kind of email on or off
set_email_notification(category, body = nil, api_key: nil, **fields) -> Hashenabled: false stops OpenEmail sending the person that kind of email, and true starts it again. activity and product can be turned off. account and billing cannot, and asking to is a 422 invalid_parameter on category.
Параметры
categoryStringОбязательноaccount,billing,activityorproduct.enabledBooleanОбязательноTrue to receive that email, false to stop it.
api_keyStringOverrides the client's API key for this call only.
Возвращает
The same Hash as account.get_notifications, as it is after the change.
Пример
client.account.set_email_notification("product", enabled: false)Примечания
Retried automatically on network failure, since the same setting sent twice changes nothing.
Также доступно в
account.set_push_muted
Mute a workspace on your phone
set_push_muted(workspace_id, body = nil, api_key: nil, **fields) -> Hashmuted: true stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and false lets it notify them again.
Параметры
workspace_idStringОбязательноA workspace id from
workspaces.list.mutedBooleanОбязательноTrue to mute it, false to let it notify again.
api_keyStringOverrides the client's API key for this call only.
Возвращает
The same Hash as account.get_notifications, with the new mutedWorkspaces.
Пример
settings = client.account.set_push_muted("10417196-e324-4283-af98-66ec62167c47", muted: true) p settings[:mutedWorkspaces]Примечания
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since the same setting sent twice changes nothing.
Также доступно в
account.set_photo
Set your profile photo
set_photo(data, content_type: nil, api_key: nil) -> HashSends the image bytes as the request body, replacing the person's profile photo, as Account, Profile does. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP and keeps the first frame of an animation.
data is a binary String, an IO or a Pathname. The type is read from content_type:, or, when that is left out, from the content_type of data itself or the extension of its file name. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Параметры
dataString, IO or PathnameОбязательноThe image: a binary
String, anIOor aPathname.content_typeStringimage/png,image/jpeg,image/webporimage/gif. Required unlessdatacarries its type, as an object with acontent_typeor aPathnameorFilenamed with the extension of the type.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with the new url.
Пример
photo = client.account.set_photo(File.binread("photo.jpg"), content_type: "image/jpeg") puts photo[:url]Примечания
A busy image service answers 503
image_busy, which the SDK retries like any other 503.Every upload gets a new URL, so a cached old photo never shows under the new one.
Также доступно в
- API
PUT /account/photo- TypeScript
account.setPhoto()- Python
account.set_photo()- CLI
openemail account set-photo
account.remove_photo
Remove your profile photo
remove_photo(api_key: nil) -> HashRemoves the profile photo and deletes the stored image, so the app shows the person's initials again. Removing it when there is none changes nothing.
Параметры
api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with url nil.
Пример
client.account.remove_photoПримечания
Safe to replay, so the SDK retries it after a network failure.
Также доступно в
account.get_username
Read your username
get_username(api_key: nil) -> HashReturns the person's username, whether they chose it or it was made for them from their name, and the free address it gives them when this deployment offers one. A username the person chose never changes.
Параметры
api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with username, chosen and address.
Пример
username, chosen, address = client.account.get_username.values_at(:username, :chosen, :address) puts username, chosen ? "chosen" : "made for you", addressПримечания
The first read makes a username for an account that has none.
Также доступно в
account.check_username
Check a username
check_username(username, api_key: nil) -> HashSays whether the person could choose a username, without choosing it, and why not when they could not. The username is lowercased and its spaces become dots before it is checked, as the app does, and username in the answer is the form that was checked.
Параметры
usernameStringОбязательноUp to 60 characters before it is tidied.
api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with status, available and a message that says why.
Пример
check = client.account.check_username("ada.lovelace") puts check[:message] unless check[:available]Примечания
statusiscurrentfor the username the person already has, andavailableis false for it.
Также доступно в
account.set_username
Choose your username
set_username(username, api_key: nil) -> HashSets the person's username for good, and with it their free address. Once chosen it never changes: a second choice is refused with 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with check_username.
Параметры
usernameStringОбязательно3 to 30 lowercase letters, numbers and single dots once it is tidied.
api_keyStringOverrides the client's API key for this call only.
Возвращает
The same Hash as account.get_username, with chosen set to true.
Пример
check = client.account.check_username("ada.lovelace") if check[:available] == false puts check[:message]else client.account.set_username(check[:username])endПримечания
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
Также доступно в
account.list_connected_apps
List your connected apps
list_connected_apps(api_key: nil) -> Array<Hash>Returns every app the person connected with OAuth, as Account, Connected apps lists them: the workspace and the permissions each may reach, until when, how many tokens it holds, and until when it may make changes that ask for a verification code without one. current marks the app making the call.
What an app may reach is changed in the app, never through an app.
Параметры
api_keyStringOverrides the client's API key for this call only.
Возвращает
An Array of Hashes, each with clientId, name, kind, status, grant and tokenCount.
Пример
apps = client.account.list_connected_apps apps.each do |app| label = app[:current] ? "(this app)" : "" puts "#{app[:name]} #{app[:status]} #{label}"endПримечания
A sign-in of the command line tool shows as
kind: "cli", with its device incliDevice.
Также доступно в
account.revoke_connected_app
Remove a connected app
revoke_connected_app(client_id, api_key: nil) -> HashDeletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again, as removing it in Account, Connected apps does. Removing the app making the call disconnects it.
Параметры
client_idStringОбязательноThe app's
clientIdfromlist_connected_apps.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with revoked set to true and tokensRevoked.
Пример
revoked = client.account.revoke_connected_app("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR") puts revoked[:tokensRevoked]Примечания
An app the person never connected is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the app is already gone.
Также доступно в
account.list_invitations
List your invitations
list_invitations(api_key: nil) -> Array<Hash>Returns the invitations to join a workspace that are waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out. The invitations a workspace sent are members.list_invitations instead.
Параметры
api_keyStringOverrides the client's API key for this call only.
Возвращает
An Array of Hashes, each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Пример
invitations = client.account.list_invitations invitations.each { |invitation| puts "#{invitation[:workspaceName]} #{invitation[:roleName]}" }Примечания
addressescounts the addresses and the whole domains the invitation gives together.
Также доступно в
account.accept_invitation
Accept an invitation
accept_invitation(invitation_id, activate: nil, api_key: nil) -> HashJoins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate: true also makes it the workspace the app opens for the person.
A workspace that asks everyone in it to sign in with two-factor authentication is refused with 403 two_factor_required until the person turns it on. An invitation that expired, was withdrawn or went to another address is a 422, and one that is not waiting any more a 404 invitation_not_found.
Параметры
invitation_idStringОбязательноAn invitation id from
list_invitations.activateBooleanTrue to make it the workspace the app opens. Defaults to false.
api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Пример
first = client.account.list_invitations.first if first joined = client.account.accept_invitation(first[:id], activate: true) puts joined[:workspaceName]endПримечания
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
Также доступно в
account.decline_invitation
Decline an invitation
decline_invitation(invitation_id, api_key: nil) -> HashTurns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation the person already accepted is refused with 409 invitation_accepted.
Параметры
invitation_idStringОбязательноAn invitation id from
list_invitations.api_keyStringOverrides the client's API key for this call only.
Возвращает
A Hash with declined set to true.
Пример
client.account.decline_invitation("winv_6bb640f5b99e47deb758f1f5")Примечания
Retried automatically on network failure, since declining twice changes nothing.