lockally 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +143 -119
- data/docs/AdminApi.md +33 -33
- data/docs/{V1AdminLoginPost200Response.md → AdminLogin200Response.md} +2 -2
- data/docs/{V1AdminLoginPostRequest.md → AdminLoginRequest.md} +2 -2
- data/docs/AdminsApi.md +76 -76
- data/docs/AgentSendResult.md +22 -0
- data/docs/AgentsApi.md +247 -247
- data/docs/AiApi.md +69 -69
- data/docs/AiConfig.md +26 -0
- data/docs/AiConfigUpdate.md +20 -0
- data/docs/AliasesApi.md +59 -59
- data/docs/ApiKeysApi.md +59 -59
- data/docs/ContactLookup.md +26 -0
- data/docs/ContactLookupContact.md +28 -0
- data/docs/ContactLookupHistory.md +22 -0
- data/docs/CreateAiUnitsCheckout200Response.md +22 -0
- data/docs/{V1AliasesPostRequest.md → CreateAliasRequest.md} +2 -2
- data/docs/{V1ApiKeysPost201Response.md → CreateApiKey201Response.md} +2 -2
- data/docs/{V1ApiKeysPostRequest.md → CreateApiKeyRequest.md} +2 -2
- data/docs/{V1DomainsPostRequest.md → CreateDomainRequest.md} +2 -2
- data/docs/{V1MailboxesPostRequest.md → CreateMailboxRequest.md} +2 -2
- data/docs/{V1SuppressionsPostRequest.md → CreateSuppressionRequest.md} +2 -2
- data/docs/{V1WebhooksPostRequest.md → CreateWebhookRequest.md} +2 -2
- data/docs/DomainsApi.md +141 -141
- data/docs/Draft.md +44 -0
- data/docs/DraftList.md +18 -0
- data/docs/DraftResult.md +26 -0
- data/docs/DraftsApi.md +115 -115
- data/docs/{V1MailboxesEmailExportPost201Response.md → ExportMailbox201Response.md} +2 -2
- data/docs/{V1AdminMeGet200Response.md → GetCurrentAdmin200Response.md} +2 -2
- data/docs/{V1UsageGet200Response.md → GetUsage200Response.md} +2 -2
- data/docs/HealthApi.md +11 -11
- data/docs/{HealthzGet200Response.md → HealthCheck200Response.md} +2 -2
- data/docs/Inbox.md +24 -0
- data/docs/InboxList.md +18 -0
- data/docs/{V1AdminsPostRequest.md → InviteAdminRequest.md} +2 -2
- data/docs/{V1AdminsGet200Response.md → ListAdmins200Response.md} +2 -2
- data/docs/{V1AliasesGet200Response.md → ListAliases200Response.md} +2 -2
- data/docs/{V1ApiKeysGet200Response.md → ListApiKeys200Response.md} +2 -2
- data/docs/{V1DomainsGet200Response.md → ListDomains200Response.md} +2 -2
- data/docs/{V1MailboxesGet200Response.md → ListMailboxes200Response.md} +2 -2
- data/docs/{V1MessagesGet200Response.md → ListMessages200Response.md} +2 -2
- data/docs/{V1SuppressionsGet200Response.md → ListSuppressions200Response.md} +2 -2
- data/docs/{V1TemplatesGet200Response.md → ListTemplates200Response.md} +2 -2
- data/docs/{V1VacationGet200Response.md → ListVacationResponders200Response.md} +2 -2
- data/docs/{V1WebhooksGet200Response.md → ListWebhooks200Response.md} +2 -2
- data/docs/MailboxGrant.md +20 -0
- data/docs/MailboxGrantList.md +18 -0
- data/docs/MailboxesApi.md +203 -203
- data/docs/MarkReadResult.md +18 -0
- data/docs/SendApi.md +121 -121
- data/docs/{V1SendPost200Response.md → SendEmail200Response.md} +2 -2
- data/docs/{V1SendPost202Response.md → SendEmail202Response.md} +2 -2
- data/docs/{V1SendBatchPost200Response.md → SendEmailBatch200Response.md} +2 -2
- data/docs/{V1SendBatchPostRequest.md → SendEmailBatchRequest.md} +2 -2
- data/docs/{V1SendPostRequest.md → SendEmailRequest.md} +3 -3
- data/docs/{V1SendPostRequestAttachmentsInner.md → SendEmailRequestAttachmentsInner.md} +2 -2
- data/docs/SendMessage.md +1 -1
- data/docs/{V1MailboxesEmailVacationPutRequest.md → SetVacationResponderRequest.md} +2 -2
- data/docs/SignupApi.md +4 -4
- data/docs/SimulatedInbound.md +22 -0
- data/docs/{V1InboxesMailboxMessagesPostRequest.md → StartConversationRequest.md} +2 -2
- data/docs/SuppressionsApi.md +75 -75
- data/docs/TemplatesApi.md +67 -67
- data/docs/TenantApi.md +20 -20
- data/docs/TestApi.md +11 -11
- data/docs/Thread.md +22 -0
- data/docs/ThreadClassification.md +22 -0
- data/docs/ThreadList.md +20 -0
- data/docs/ThreadMessage.md +40 -0
- data/docs/ThreadMessageBody.md +42 -0
- data/docs/ThreadMessageBodyAllOfBody.md +22 -0
- data/docs/ThreadSummary.md +28 -0
- data/docs/{V1AdminsIdPatchRequest.md → UpdateAdminRequest.md} +2 -2
- data/docs/{V1MailboxesEmailPatchRequest.md → UpdateMailboxRequest.md} +2 -2
- data/docs/{V1WebhooksIdPatchRequest.md → UpdateWebhookRequest.md} +2 -2
- data/docs/WebhooksApi.md +63 -63
- data/docs/Whoami.md +24 -0
- data/lib/lockally/api/admin_api.rb +30 -30
- data/lib/lockally/api/admins_api.rb +89 -89
- data/lib/lockally/api/agents_api.rb +309 -309
- data/lib/lockally/api/ai_api.rb +69 -69
- data/lib/lockally/api/aliases_api.rb +64 -64
- data/lib/lockally/api/api_keys_api.rb +66 -66
- data/lib/lockally/api/domains_api.rb +147 -147
- data/lib/lockally/api/drafts_api.rb +140 -140
- data/lib/lockally/api/health_api.rb +9 -9
- data/lib/lockally/api/mailboxes_api.rb +233 -233
- data/lib/lockally/api/send_api.rb +146 -146
- data/lib/lockally/api/signup_api.rb +3 -3
- data/lib/lockally/api/suppressions_api.rb +87 -87
- data/lib/lockally/api/templates_api.rb +69 -69
- data/lib/lockally/api/tenant_api.rb +15 -15
- data/lib/lockally/api/test_api.rb +9 -9
- data/lib/lockally/api/webhooks_api.rb +73 -73
- data/lib/lockally/models/{v1_admin_login_post200_response.rb → admin_login200_response.rb} +3 -3
- data/lib/lockally/models/{v1_admin_login_post_request.rb → admin_login_request.rb} +3 -3
- data/lib/lockally/models/agent_send_result.rb +184 -0
- data/lib/lockally/models/ai_config.rb +242 -0
- data/lib/lockally/models/ai_config_update.rb +214 -0
- data/lib/lockally/models/contact_lookup.rb +235 -0
- data/lib/lockally/models/contact_lookup_contact.rb +192 -0
- data/lib/lockally/models/contact_lookup_history.rb +166 -0
- data/lib/lockally/models/create_ai_units_checkout200_response.rb +199 -0
- data/lib/lockally/models/{v1_aliases_post_request.rb → create_alias_request.rb} +3 -3
- data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb} +3 -3
- data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb} +3 -3
- data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb} +3 -3
- data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb} +3 -3
- data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb} +3 -3
- data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb} +3 -3
- data/lib/lockally/models/draft.rb +413 -0
- data/lib/lockally/models/draft_list.rb +166 -0
- data/lib/lockally/models/draft_result.rb +260 -0
- data/lib/lockally/models/{v1_mailboxes_email_export_post201_response.rb → export_mailbox201_response.rb} +3 -3
- data/lib/lockally/models/{v1_admin_me_get200_response.rb → get_current_admin200_response.rb} +3 -3
- data/lib/lockally/models/{v1_usage_get200_response.rb → get_usage200_response.rb} +3 -3
- data/lib/lockally/models/{healthz_get200_response.rb → health_check200_response.rb} +3 -3
- data/lib/lockally/models/inbox.rb +225 -0
- data/lib/lockally/models/inbox_list.rb +166 -0
- data/lib/lockally/models/{v1_admins_post_request.rb → invite_admin_request.rb} +3 -3
- data/lib/lockally/models/list_admins200_response.rb +166 -0
- data/lib/lockally/models/{v1_aliases_get200_response.rb → list_aliases200_response.rb} +3 -3
- data/lib/lockally/models/{v1_admins_get200_response.rb → list_api_keys200_response.rb} +4 -4
- data/lib/lockally/models/{v1_domains_get200_response.rb → list_domains200_response.rb} +3 -3
- data/lib/lockally/models/{v1_mailboxes_get200_response.rb → list_mailboxes200_response.rb} +3 -3
- data/lib/lockally/models/{v1_messages_get200_response.rb → list_messages200_response.rb} +3 -3
- data/lib/lockally/models/{v1_suppressions_get200_response.rb → list_suppressions200_response.rb} +3 -3
- data/lib/lockally/models/{v1_send_batch_post200_response.rb → list_templates200_response.rb} +4 -4
- data/lib/lockally/models/{v1_vacation_get200_response.rb → list_vacation_responders200_response.rb} +3 -3
- data/lib/lockally/models/{v1_api_keys_get200_response.rb → list_webhooks200_response.rb} +4 -4
- data/lib/lockally/models/mailbox_grant.rb +156 -0
- data/lib/lockally/models/mailbox_grant_list.rb +166 -0
- data/lib/lockally/models/mark_read_result.rb +147 -0
- data/lib/lockally/models/{v1_send_post200_response.rb → send_email200_response.rb} +3 -3
- data/lib/lockally/models/{v1_send_post202_response.rb → send_email202_response.rb} +3 -3
- data/lib/lockally/models/{v1_templates_get200_response.rb → send_email_batch200_response.rb} +4 -4
- data/lib/lockally/models/{v1_send_batch_post_request.rb → send_email_batch_request.rb} +3 -3
- data/lib/lockally/models/{v1_send_post_request.rb → send_email_request.rb} +4 -4
- data/lib/lockally/models/{v1_send_post_request_attachments_inner.rb → send_email_request_attachments_inner.rb} +3 -3
- data/lib/lockally/models/send_message.rb +1 -1
- data/lib/lockally/models/{v1_mailboxes_email_vacation_put_request.rb → set_vacation_responder_request.rb} +3 -3
- data/lib/lockally/models/simulated_inbound.rb +167 -0
- data/lib/lockally/models/{v1_inboxes_mailbox_messages_post_request.rb → start_conversation_request.rb} +3 -3
- data/lib/lockally/models/thread.rb +219 -0
- data/lib/lockally/models/thread_classification.rb +186 -0
- data/lib/lockally/models/thread_list.rb +192 -0
- data/lib/lockally/models/thread_message.rb +397 -0
- data/lib/lockally/models/thread_message_body.rb +413 -0
- data/lib/lockally/models/thread_message_body_all_of_body.rb +165 -0
- data/lib/lockally/models/thread_summary.rb +280 -0
- data/lib/lockally/models/{v1_admins_id_patch_request.rb → update_admin_request.rb} +3 -3
- data/lib/lockally/models/{v1_mailboxes_email_patch_request.rb → update_mailbox_request.rb} +3 -3
- data/lib/lockally/models/{v1_webhooks_id_patch_request.rb → update_webhook_request.rb} +3 -3
- data/lib/lockally/models/whoami.rb +177 -0
- data/lib/lockally/version.rb +1 -1
- data/lib/lockally.rb +59 -35
- data/spec/api/admin_api_spec.rb +9 -9
- data/spec/api/admins_api_spec.rb +22 -22
- data/spec/api/agents_api_spec.rb +78 -78
- data/spec/api/ai_api_spec.rb +22 -22
- data/spec/api/aliases_api_spec.rb +16 -16
- data/spec/api/api_keys_api_spec.rb +17 -17
- data/spec/api/domains_api_spec.rb +42 -42
- data/spec/api/drafts_api_spec.rb +38 -38
- data/spec/api/health_api_spec.rb +3 -3
- data/spec/api/mailboxes_api_spec.rb +61 -61
- data/spec/api/send_api_spec.rb +35 -35
- data/spec/api/signup_api_spec.rb +1 -1
- data/spec/api/suppressions_api_spec.rb +18 -18
- data/spec/api/templates_api_spec.rb +17 -17
- data/spec/api/tenant_api_spec.rb +5 -5
- data/spec/api/test_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +19 -19
- data/spec/models/{v1_admin_login_post200_response_spec.rb → admin_login200_response_spec.rb} +6 -6
- data/spec/models/{v1_admin_login_post_request_spec.rb → admin_login_request_spec.rb} +6 -6
- data/spec/models/agent_send_result_spec.rb +48 -0
- data/spec/models/ai_config_spec.rb +64 -0
- data/spec/models/ai_config_update_spec.rb +46 -0
- data/spec/models/contact_lookup_contact_spec.rb +66 -0
- data/spec/models/contact_lookup_history_spec.rb +48 -0
- data/spec/models/contact_lookup_spec.rb +60 -0
- data/spec/models/create_ai_units_checkout200_response_spec.rb +48 -0
- data/spec/models/{v1_aliases_post_request_spec.rb → create_alias_request_spec.rb} +6 -6
- data/spec/models/{v1_api_keys_post201_response_spec.rb → create_api_key201_response_spec.rb} +6 -6
- data/spec/models/{v1_api_keys_post_request_spec.rb → create_api_key_request_spec.rb} +6 -6
- data/spec/models/{v1_domains_post_request_spec.rb → create_domain_request_spec.rb} +6 -6
- data/spec/models/{v1_mailboxes_post_request_spec.rb → create_mailbox_request_spec.rb} +6 -6
- data/spec/models/{v1_suppressions_post_request_spec.rb → create_suppression_request_spec.rb} +6 -6
- data/spec/models/{v1_webhooks_post_request_spec.rb → create_webhook_request_spec.rb} +6 -6
- data/spec/models/draft_list_spec.rb +36 -0
- data/spec/models/draft_result_spec.rb +64 -0
- data/spec/models/draft_spec.rb +118 -0
- data/spec/models/{v1_mailboxes_email_export_post201_response_spec.rb → export_mailbox201_response_spec.rb} +6 -6
- data/spec/models/{v1_admin_me_get200_response_spec.rb → get_current_admin200_response_spec.rb} +6 -6
- data/spec/models/{v1_usage_get200_response_spec.rb → get_usage200_response_spec.rb} +6 -6
- data/spec/models/{healthz_get200_response_spec.rb → health_check200_response_spec.rb} +6 -6
- data/spec/models/inbox_list_spec.rb +36 -0
- data/spec/models/inbox_spec.rb +54 -0
- data/spec/models/{v1_admins_post_request_spec.rb → invite_admin_request_spec.rb} +6 -6
- data/spec/models/{v1_aliases_get200_response_spec.rb → list_admins200_response_spec.rb} +6 -6
- data/spec/models/{v1_admins_get200_response_spec.rb → list_aliases200_response_spec.rb} +6 -6
- data/spec/models/{v1_api_keys_get200_response_spec.rb → list_api_keys200_response_spec.rb} +6 -6
- data/spec/models/list_domains200_response_spec.rb +36 -0
- data/spec/models/{v1_mailboxes_get200_response_spec.rb → list_mailboxes200_response_spec.rb} +6 -6
- data/spec/models/{v1_messages_get200_response_spec.rb → list_messages200_response_spec.rb} +6 -6
- data/spec/models/{v1_suppressions_get200_response_spec.rb → list_suppressions200_response_spec.rb} +6 -6
- data/spec/models/{v1_vacation_get200_response_spec.rb → list_templates200_response_spec.rb} +6 -6
- data/spec/models/list_vacation_responders200_response_spec.rb +36 -0
- data/spec/models/{v1_domains_get200_response_spec.rb → list_webhooks200_response_spec.rb} +6 -6
- data/spec/models/mailbox_grant_list_spec.rb +36 -0
- data/spec/models/mailbox_grant_spec.rb +42 -0
- data/spec/models/mark_read_result_spec.rb +36 -0
- data/spec/models/{v1_send_post200_response_spec.rb → send_email200_response_spec.rb} +6 -6
- data/spec/models/{v1_send_post202_response_spec.rb → send_email202_response_spec.rb} +6 -6
- data/spec/models/{v1_templates_get200_response_spec.rb → send_email_batch200_response_spec.rb} +6 -6
- data/spec/models/{v1_send_batch_post_request_spec.rb → send_email_batch_request_spec.rb} +6 -6
- data/spec/models/{v1_send_post_request_attachments_inner_spec.rb → send_email_request_attachments_inner_spec.rb} +6 -6
- data/spec/models/{v1_send_post_request_spec.rb → send_email_request_spec.rb} +6 -6
- data/spec/models/{v1_mailboxes_email_vacation_put_request_spec.rb → set_vacation_responder_request_spec.rb} +6 -6
- data/spec/models/simulated_inbound_spec.rb +48 -0
- data/spec/models/{v1_inboxes_mailbox_messages_post_request_spec.rb → start_conversation_request_spec.rb} +6 -6
- data/spec/models/thread_classification_spec.rb +48 -0
- data/spec/models/thread_list_spec.rb +42 -0
- data/spec/models/thread_message_body_all_of_body_spec.rb +48 -0
- data/spec/models/thread_message_body_spec.rb +112 -0
- data/spec/models/thread_message_spec.rb +106 -0
- data/spec/models/thread_spec.rb +48 -0
- data/spec/models/thread_summary_spec.rb +70 -0
- data/spec/models/{v1_admins_id_patch_request_spec.rb → update_admin_request_spec.rb} +6 -6
- data/spec/models/{v1_mailboxes_email_patch_request_spec.rb → update_mailbox_request_spec.rb} +6 -6
- data/spec/models/{v1_webhooks_id_patch_request_spec.rb → update_webhook_request_spec.rb} +6 -6
- data/spec/models/whoami_spec.rb +54 -0
- metadata +238 -142
- data/lib/lockally/models/v1_webhooks_get200_response.rb +0 -166
- data/spec/models/v1_send_batch_post200_response_spec.rb +0 -36
- data/spec/models/v1_webhooks_get200_response_spec.rb +0 -36
data/docs/DraftList.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Lockally::DraftList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **drafts** | [**Array<Draft>**](Draft.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'lockally'
|
|
13
|
+
|
|
14
|
+
instance = Lockally::DraftList.new(
|
|
15
|
+
drafts: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/DraftResult.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Lockally::DraftResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **draft_id** | **String** | | |
|
|
8
|
+
| **status** | **String** | | |
|
|
9
|
+
| **policy_flags** | **Hash<String, Object>** | | |
|
|
10
|
+
| **thread_id** | **String** | | [optional] |
|
|
11
|
+
| **sent** | [**AgentSendResult**](AgentSendResult.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'lockally'
|
|
17
|
+
|
|
18
|
+
instance = Lockally::DraftResult.new(
|
|
19
|
+
draft_id: null,
|
|
20
|
+
status: null,
|
|
21
|
+
policy_flags: null,
|
|
22
|
+
thread_id: null,
|
|
23
|
+
sent: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/DraftsApi.md
CHANGED
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://api.lockally.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
7
|
+
| [**approve_draft**](DraftsApi.md#approve_draft) | **POST** /v1/drafts/{draftID}/approve | Approve a pending draft (human) |
|
|
8
|
+
| [**cancel_draft**](DraftsApi.md#cancel_draft) | **POST** /v1/drafts/{draftID}/cancel | Withdraw a pending draft |
|
|
9
|
+
| [**create_conversation_draft**](DraftsApi.md#create_conversation_draft) | **POST** /v1/inboxes/{mailbox}/drafts | Propose a new conversation as a draft |
|
|
10
|
+
| [**create_reply_draft**](DraftsApi.md#create_reply_draft) | **POST** /v1/threads/{threadID}/drafts | Propose a reply as a draft |
|
|
11
|
+
| [**get_draft**](DraftsApi.md#get_draft) | **GET** /v1/drafts/{draftID} | Get a draft |
|
|
12
|
+
| [**list_drafts**](DraftsApi.md#list_drafts) | **GET** /v1/drafts | List drafts |
|
|
13
|
+
| [**reject_draft**](DraftsApi.md#reject_draft) | **POST** /v1/drafts/{draftID}/reject | Reject a pending draft (human) |
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## approve_draft
|
|
17
17
|
|
|
18
|
-
>
|
|
18
|
+
> <DraftResult> approve_draft(draft_id)
|
|
19
19
|
|
|
20
20
|
Approve a pending draft (human)
|
|
21
21
|
|
|
@@ -37,28 +37,28 @@ draft_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
37
37
|
|
|
38
38
|
begin
|
|
39
39
|
# Approve a pending draft (human)
|
|
40
|
-
result = api_instance.
|
|
40
|
+
result = api_instance.approve_draft(draft_id)
|
|
41
41
|
p result
|
|
42
42
|
rescue Lockally::ApiError => e
|
|
43
|
-
puts "Error when calling DraftsApi->
|
|
43
|
+
puts "Error when calling DraftsApi->approve_draft: #{e}"
|
|
44
44
|
end
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
#### Using the
|
|
47
|
+
#### Using the approve_draft_with_http_info variant
|
|
48
48
|
|
|
49
49
|
This returns an Array which contains the response data, status code and headers.
|
|
50
50
|
|
|
51
|
-
> <Array(
|
|
51
|
+
> <Array(<DraftResult>, Integer, Hash)> approve_draft_with_http_info(draft_id)
|
|
52
52
|
|
|
53
53
|
```ruby
|
|
54
54
|
begin
|
|
55
55
|
# Approve a pending draft (human)
|
|
56
|
-
data, status_code, headers = api_instance.
|
|
56
|
+
data, status_code, headers = api_instance.approve_draft_with_http_info(draft_id)
|
|
57
57
|
p status_code # => 2xx
|
|
58
58
|
p headers # => { ... }
|
|
59
|
-
p data # =>
|
|
59
|
+
p data # => <DraftResult>
|
|
60
60
|
rescue Lockally::ApiError => e
|
|
61
|
-
puts "Error when calling DraftsApi->
|
|
61
|
+
puts "Error when calling DraftsApi->approve_draft_with_http_info: #{e}"
|
|
62
62
|
end
|
|
63
63
|
```
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ end
|
|
|
70
70
|
|
|
71
71
|
### Return type
|
|
72
72
|
|
|
73
|
-
**
|
|
73
|
+
[**DraftResult**](DraftResult.md)
|
|
74
74
|
|
|
75
75
|
### Authorization
|
|
76
76
|
|
|
@@ -82,9 +82,9 @@ end
|
|
|
82
82
|
- **Accept**: application/json
|
|
83
83
|
|
|
84
84
|
|
|
85
|
-
##
|
|
85
|
+
## cancel_draft
|
|
86
86
|
|
|
87
|
-
>
|
|
87
|
+
> <Draft> cancel_draft(draft_id)
|
|
88
88
|
|
|
89
89
|
Withdraw a pending draft
|
|
90
90
|
|
|
@@ -106,28 +106,28 @@ draft_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
106
106
|
|
|
107
107
|
begin
|
|
108
108
|
# Withdraw a pending draft
|
|
109
|
-
result = api_instance.
|
|
109
|
+
result = api_instance.cancel_draft(draft_id)
|
|
110
110
|
p result
|
|
111
111
|
rescue Lockally::ApiError => e
|
|
112
|
-
puts "Error when calling DraftsApi->
|
|
112
|
+
puts "Error when calling DraftsApi->cancel_draft: #{e}"
|
|
113
113
|
end
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
#### Using the
|
|
116
|
+
#### Using the cancel_draft_with_http_info variant
|
|
117
117
|
|
|
118
118
|
This returns an Array which contains the response data, status code and headers.
|
|
119
119
|
|
|
120
|
-
> <Array(
|
|
120
|
+
> <Array(<Draft>, Integer, Hash)> cancel_draft_with_http_info(draft_id)
|
|
121
121
|
|
|
122
122
|
```ruby
|
|
123
123
|
begin
|
|
124
124
|
# Withdraw a pending draft
|
|
125
|
-
data, status_code, headers = api_instance.
|
|
125
|
+
data, status_code, headers = api_instance.cancel_draft_with_http_info(draft_id)
|
|
126
126
|
p status_code # => 2xx
|
|
127
127
|
p headers # => { ... }
|
|
128
|
-
p data # =>
|
|
128
|
+
p data # => <Draft>
|
|
129
129
|
rescue Lockally::ApiError => e
|
|
130
|
-
puts "Error when calling DraftsApi->
|
|
130
|
+
puts "Error when calling DraftsApi->cancel_draft_with_http_info: #{e}"
|
|
131
131
|
end
|
|
132
132
|
```
|
|
133
133
|
|
|
@@ -139,7 +139,7 @@ end
|
|
|
139
139
|
|
|
140
140
|
### Return type
|
|
141
141
|
|
|
142
|
-
**
|
|
142
|
+
[**Draft**](Draft.md)
|
|
143
143
|
|
|
144
144
|
### Authorization
|
|
145
145
|
|
|
@@ -151,11 +151,13 @@ end
|
|
|
151
151
|
- **Accept**: application/json
|
|
152
152
|
|
|
153
153
|
|
|
154
|
-
##
|
|
154
|
+
## create_conversation_draft
|
|
155
155
|
|
|
156
|
-
>
|
|
156
|
+
> <DraftResult> create_conversation_draft(mailbox, idempotency_key)
|
|
157
157
|
|
|
158
|
-
|
|
158
|
+
Propose a new conversation as a draft
|
|
159
|
+
|
|
160
|
+
New-conversation drafts ALWAYS require human approval (policy flag new_thread). Idempotency-Key required.
|
|
159
161
|
|
|
160
162
|
### Examples
|
|
161
163
|
|
|
@@ -169,32 +171,33 @@ Lockally.configure do |config|
|
|
|
169
171
|
end
|
|
170
172
|
|
|
171
173
|
api_instance = Lockally::DraftsApi.new
|
|
172
|
-
|
|
174
|
+
mailbox = 'mailbox_example' # String |
|
|
175
|
+
idempotency_key = 'idempotency_key_example' # String |
|
|
173
176
|
|
|
174
177
|
begin
|
|
175
|
-
#
|
|
176
|
-
result = api_instance.
|
|
178
|
+
# Propose a new conversation as a draft
|
|
179
|
+
result = api_instance.create_conversation_draft(mailbox, idempotency_key)
|
|
177
180
|
p result
|
|
178
181
|
rescue Lockally::ApiError => e
|
|
179
|
-
puts "Error when calling DraftsApi->
|
|
182
|
+
puts "Error when calling DraftsApi->create_conversation_draft: #{e}"
|
|
180
183
|
end
|
|
181
184
|
```
|
|
182
185
|
|
|
183
|
-
#### Using the
|
|
186
|
+
#### Using the create_conversation_draft_with_http_info variant
|
|
184
187
|
|
|
185
188
|
This returns an Array which contains the response data, status code and headers.
|
|
186
189
|
|
|
187
|
-
> <Array(
|
|
190
|
+
> <Array(<DraftResult>, Integer, Hash)> create_conversation_draft_with_http_info(mailbox, idempotency_key)
|
|
188
191
|
|
|
189
192
|
```ruby
|
|
190
193
|
begin
|
|
191
|
-
#
|
|
192
|
-
data, status_code, headers = api_instance.
|
|
194
|
+
# Propose a new conversation as a draft
|
|
195
|
+
data, status_code, headers = api_instance.create_conversation_draft_with_http_info(mailbox, idempotency_key)
|
|
193
196
|
p status_code # => 2xx
|
|
194
197
|
p headers # => { ... }
|
|
195
|
-
p data # =>
|
|
198
|
+
p data # => <DraftResult>
|
|
196
199
|
rescue Lockally::ApiError => e
|
|
197
|
-
puts "Error when calling DraftsApi->
|
|
200
|
+
puts "Error when calling DraftsApi->create_conversation_draft_with_http_info: #{e}"
|
|
198
201
|
end
|
|
199
202
|
```
|
|
200
203
|
|
|
@@ -202,11 +205,12 @@ end
|
|
|
202
205
|
|
|
203
206
|
| Name | Type | Description | Notes |
|
|
204
207
|
| ---- | ---- | ----------- | ----- |
|
|
205
|
-
| **
|
|
208
|
+
| **mailbox** | **String** | | |
|
|
209
|
+
| **idempotency_key** | **String** | | |
|
|
206
210
|
|
|
207
211
|
### Return type
|
|
208
212
|
|
|
209
|
-
**
|
|
213
|
+
[**DraftResult**](DraftResult.md)
|
|
210
214
|
|
|
211
215
|
### Authorization
|
|
212
216
|
|
|
@@ -218,13 +222,13 @@ end
|
|
|
218
222
|
- **Accept**: application/json
|
|
219
223
|
|
|
220
224
|
|
|
221
|
-
##
|
|
225
|
+
## create_reply_draft
|
|
222
226
|
|
|
223
|
-
>
|
|
227
|
+
> <DraftResult> create_reply_draft(thread_id, idempotency_key)
|
|
224
228
|
|
|
225
|
-
|
|
229
|
+
Propose a reply as a draft
|
|
226
230
|
|
|
227
|
-
|
|
231
|
+
The safe default over /reply: the deterministic policy engine auto-sends clean in-thread replies and holds anything risky (PII, new recipients, injection-flagged threads, always-approve mailboxes) for human approval. Fires draft.pending_approval when held. Idempotency-Key required.
|
|
228
232
|
|
|
229
233
|
### Examples
|
|
230
234
|
|
|
@@ -238,32 +242,33 @@ Lockally.configure do |config|
|
|
|
238
242
|
end
|
|
239
243
|
|
|
240
244
|
api_instance = Lockally::DraftsApi.new
|
|
241
|
-
|
|
245
|
+
thread_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
246
|
+
idempotency_key = 'idempotency_key_example' # String |
|
|
242
247
|
|
|
243
248
|
begin
|
|
244
|
-
#
|
|
245
|
-
result = api_instance.
|
|
249
|
+
# Propose a reply as a draft
|
|
250
|
+
result = api_instance.create_reply_draft(thread_id, idempotency_key)
|
|
246
251
|
p result
|
|
247
252
|
rescue Lockally::ApiError => e
|
|
248
|
-
puts "Error when calling DraftsApi->
|
|
253
|
+
puts "Error when calling DraftsApi->create_reply_draft: #{e}"
|
|
249
254
|
end
|
|
250
255
|
```
|
|
251
256
|
|
|
252
|
-
#### Using the
|
|
257
|
+
#### Using the create_reply_draft_with_http_info variant
|
|
253
258
|
|
|
254
259
|
This returns an Array which contains the response data, status code and headers.
|
|
255
260
|
|
|
256
|
-
> <Array(
|
|
261
|
+
> <Array(<DraftResult>, Integer, Hash)> create_reply_draft_with_http_info(thread_id, idempotency_key)
|
|
257
262
|
|
|
258
263
|
```ruby
|
|
259
264
|
begin
|
|
260
|
-
#
|
|
261
|
-
data, status_code, headers = api_instance.
|
|
265
|
+
# Propose a reply as a draft
|
|
266
|
+
data, status_code, headers = api_instance.create_reply_draft_with_http_info(thread_id, idempotency_key)
|
|
262
267
|
p status_code # => 2xx
|
|
263
268
|
p headers # => { ... }
|
|
264
|
-
p data # =>
|
|
269
|
+
p data # => <DraftResult>
|
|
265
270
|
rescue Lockally::ApiError => e
|
|
266
|
-
puts "Error when calling DraftsApi->
|
|
271
|
+
puts "Error when calling DraftsApi->create_reply_draft_with_http_info: #{e}"
|
|
267
272
|
end
|
|
268
273
|
```
|
|
269
274
|
|
|
@@ -271,11 +276,12 @@ end
|
|
|
271
276
|
|
|
272
277
|
| Name | Type | Description | Notes |
|
|
273
278
|
| ---- | ---- | ----------- | ----- |
|
|
274
|
-
| **
|
|
279
|
+
| **thread_id** | **String** | | |
|
|
280
|
+
| **idempotency_key** | **String** | | |
|
|
275
281
|
|
|
276
282
|
### Return type
|
|
277
283
|
|
|
278
|
-
**
|
|
284
|
+
[**DraftResult**](DraftResult.md)
|
|
279
285
|
|
|
280
286
|
### Authorization
|
|
281
287
|
|
|
@@ -287,13 +293,11 @@ end
|
|
|
287
293
|
- **Accept**: application/json
|
|
288
294
|
|
|
289
295
|
|
|
290
|
-
##
|
|
296
|
+
## get_draft
|
|
291
297
|
|
|
292
|
-
>
|
|
298
|
+
> <Draft> get_draft(draft_id)
|
|
293
299
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
Filter with ?status=pending_approval|sent|rejected|cancelled. Keys see drafts of granted mailboxes; admin sessions see all.
|
|
300
|
+
Get a draft
|
|
297
301
|
|
|
298
302
|
### Examples
|
|
299
303
|
|
|
@@ -307,35 +311,32 @@ Lockally.configure do |config|
|
|
|
307
311
|
end
|
|
308
312
|
|
|
309
313
|
api_instance = Lockally::DraftsApi.new
|
|
310
|
-
|
|
311
|
-
status: 'status_example', # String |
|
|
312
|
-
limit: 56 # Integer |
|
|
313
|
-
}
|
|
314
|
+
draft_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
314
315
|
|
|
315
316
|
begin
|
|
316
|
-
#
|
|
317
|
-
result = api_instance.
|
|
317
|
+
# Get a draft
|
|
318
|
+
result = api_instance.get_draft(draft_id)
|
|
318
319
|
p result
|
|
319
320
|
rescue Lockally::ApiError => e
|
|
320
|
-
puts "Error when calling DraftsApi->
|
|
321
|
+
puts "Error when calling DraftsApi->get_draft: #{e}"
|
|
321
322
|
end
|
|
322
323
|
```
|
|
323
324
|
|
|
324
|
-
#### Using the
|
|
325
|
+
#### Using the get_draft_with_http_info variant
|
|
325
326
|
|
|
326
327
|
This returns an Array which contains the response data, status code and headers.
|
|
327
328
|
|
|
328
|
-
> <Array(
|
|
329
|
+
> <Array(<Draft>, Integer, Hash)> get_draft_with_http_info(draft_id)
|
|
329
330
|
|
|
330
331
|
```ruby
|
|
331
332
|
begin
|
|
332
|
-
#
|
|
333
|
-
data, status_code, headers = api_instance.
|
|
333
|
+
# Get a draft
|
|
334
|
+
data, status_code, headers = api_instance.get_draft_with_http_info(draft_id)
|
|
334
335
|
p status_code # => 2xx
|
|
335
336
|
p headers # => { ... }
|
|
336
|
-
p data # =>
|
|
337
|
+
p data # => <Draft>
|
|
337
338
|
rescue Lockally::ApiError => e
|
|
338
|
-
puts "Error when calling DraftsApi->
|
|
339
|
+
puts "Error when calling DraftsApi->get_draft_with_http_info: #{e}"
|
|
339
340
|
end
|
|
340
341
|
```
|
|
341
342
|
|
|
@@ -343,12 +344,11 @@ end
|
|
|
343
344
|
|
|
344
345
|
| Name | Type | Description | Notes |
|
|
345
346
|
| ---- | ---- | ----------- | ----- |
|
|
346
|
-
| **
|
|
347
|
-
| **limit** | **Integer** | | [optional][default to 50] |
|
|
347
|
+
| **draft_id** | **String** | | |
|
|
348
348
|
|
|
349
349
|
### Return type
|
|
350
350
|
|
|
351
|
-
**
|
|
351
|
+
[**Draft**](Draft.md)
|
|
352
352
|
|
|
353
353
|
### Authorization
|
|
354
354
|
|
|
@@ -360,13 +360,13 @@ end
|
|
|
360
360
|
- **Accept**: application/json
|
|
361
361
|
|
|
362
362
|
|
|
363
|
-
##
|
|
363
|
+
## list_drafts
|
|
364
364
|
|
|
365
|
-
>
|
|
365
|
+
> <DraftList> list_drafts(opts)
|
|
366
366
|
|
|
367
|
-
|
|
367
|
+
List drafts
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Filter with ?status=pending_approval|sent|rejected|cancelled. Keys see drafts of granted mailboxes; admin sessions see all.
|
|
370
370
|
|
|
371
371
|
### Examples
|
|
372
372
|
|
|
@@ -380,33 +380,35 @@ Lockally.configure do |config|
|
|
|
380
380
|
end
|
|
381
381
|
|
|
382
382
|
api_instance = Lockally::DraftsApi.new
|
|
383
|
-
|
|
384
|
-
|
|
383
|
+
opts = {
|
|
384
|
+
status: 'status_example', # String |
|
|
385
|
+
limit: 56 # Integer |
|
|
386
|
+
}
|
|
385
387
|
|
|
386
388
|
begin
|
|
387
|
-
#
|
|
388
|
-
result = api_instance.
|
|
389
|
+
# List drafts
|
|
390
|
+
result = api_instance.list_drafts(opts)
|
|
389
391
|
p result
|
|
390
392
|
rescue Lockally::ApiError => e
|
|
391
|
-
puts "Error when calling DraftsApi->
|
|
393
|
+
puts "Error when calling DraftsApi->list_drafts: #{e}"
|
|
392
394
|
end
|
|
393
395
|
```
|
|
394
396
|
|
|
395
|
-
#### Using the
|
|
397
|
+
#### Using the list_drafts_with_http_info variant
|
|
396
398
|
|
|
397
399
|
This returns an Array which contains the response data, status code and headers.
|
|
398
400
|
|
|
399
|
-
> <Array(
|
|
401
|
+
> <Array(<DraftList>, Integer, Hash)> list_drafts_with_http_info(opts)
|
|
400
402
|
|
|
401
403
|
```ruby
|
|
402
404
|
begin
|
|
403
|
-
#
|
|
404
|
-
data, status_code, headers = api_instance.
|
|
405
|
+
# List drafts
|
|
406
|
+
data, status_code, headers = api_instance.list_drafts_with_http_info(opts)
|
|
405
407
|
p status_code # => 2xx
|
|
406
408
|
p headers # => { ... }
|
|
407
|
-
p data # =>
|
|
409
|
+
p data # => <DraftList>
|
|
408
410
|
rescue Lockally::ApiError => e
|
|
409
|
-
puts "Error when calling DraftsApi->
|
|
411
|
+
puts "Error when calling DraftsApi->list_drafts_with_http_info: #{e}"
|
|
410
412
|
end
|
|
411
413
|
```
|
|
412
414
|
|
|
@@ -414,12 +416,12 @@ end
|
|
|
414
416
|
|
|
415
417
|
| Name | Type | Description | Notes |
|
|
416
418
|
| ---- | ---- | ----------- | ----- |
|
|
417
|
-
| **
|
|
418
|
-
| **
|
|
419
|
+
| **status** | **String** | | [optional] |
|
|
420
|
+
| **limit** | **Integer** | | [optional][default to 50] |
|
|
419
421
|
|
|
420
422
|
### Return type
|
|
421
423
|
|
|
422
|
-
**
|
|
424
|
+
[**DraftList**](DraftList.md)
|
|
423
425
|
|
|
424
426
|
### Authorization
|
|
425
427
|
|
|
@@ -431,13 +433,13 @@ end
|
|
|
431
433
|
- **Accept**: application/json
|
|
432
434
|
|
|
433
435
|
|
|
434
|
-
##
|
|
436
|
+
## reject_draft
|
|
435
437
|
|
|
436
|
-
>
|
|
438
|
+
> <Draft> reject_draft(draft_id)
|
|
437
439
|
|
|
438
|
-
|
|
440
|
+
Reject a pending draft (human)
|
|
439
441
|
|
|
440
|
-
|
|
442
|
+
Body: {\"reason\": \"...\"} (optional). Fires draft.rejected.
|
|
441
443
|
|
|
442
444
|
### Examples
|
|
443
445
|
|
|
@@ -451,33 +453,32 @@ Lockally.configure do |config|
|
|
|
451
453
|
end
|
|
452
454
|
|
|
453
455
|
api_instance = Lockally::DraftsApi.new
|
|
454
|
-
|
|
455
|
-
idempotency_key = 'idempotency_key_example' # String |
|
|
456
|
+
draft_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
456
457
|
|
|
457
458
|
begin
|
|
458
|
-
#
|
|
459
|
-
result = api_instance.
|
|
459
|
+
# Reject a pending draft (human)
|
|
460
|
+
result = api_instance.reject_draft(draft_id)
|
|
460
461
|
p result
|
|
461
462
|
rescue Lockally::ApiError => e
|
|
462
|
-
puts "Error when calling DraftsApi->
|
|
463
|
+
puts "Error when calling DraftsApi->reject_draft: #{e}"
|
|
463
464
|
end
|
|
464
465
|
```
|
|
465
466
|
|
|
466
|
-
#### Using the
|
|
467
|
+
#### Using the reject_draft_with_http_info variant
|
|
467
468
|
|
|
468
469
|
This returns an Array which contains the response data, status code and headers.
|
|
469
470
|
|
|
470
|
-
> <Array(
|
|
471
|
+
> <Array(<Draft>, Integer, Hash)> reject_draft_with_http_info(draft_id)
|
|
471
472
|
|
|
472
473
|
```ruby
|
|
473
474
|
begin
|
|
474
|
-
#
|
|
475
|
-
data, status_code, headers = api_instance.
|
|
475
|
+
# Reject a pending draft (human)
|
|
476
|
+
data, status_code, headers = api_instance.reject_draft_with_http_info(draft_id)
|
|
476
477
|
p status_code # => 2xx
|
|
477
478
|
p headers # => { ... }
|
|
478
|
-
p data # =>
|
|
479
|
+
p data # => <Draft>
|
|
479
480
|
rescue Lockally::ApiError => e
|
|
480
|
-
puts "Error when calling DraftsApi->
|
|
481
|
+
puts "Error when calling DraftsApi->reject_draft_with_http_info: #{e}"
|
|
481
482
|
end
|
|
482
483
|
```
|
|
483
484
|
|
|
@@ -485,12 +486,11 @@ end
|
|
|
485
486
|
|
|
486
487
|
| Name | Type | Description | Notes |
|
|
487
488
|
| ---- | ---- | ----------- | ----- |
|
|
488
|
-
| **
|
|
489
|
-
| **idempotency_key** | **String** | | |
|
|
489
|
+
| **draft_id** | **String** | | |
|
|
490
490
|
|
|
491
491
|
### Return type
|
|
492
492
|
|
|
493
|
-
**
|
|
493
|
+
[**Draft**](Draft.md)
|
|
494
494
|
|
|
495
495
|
### Authorization
|
|
496
496
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Lockally::
|
|
1
|
+
# Lockally::ExportMailbox201Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'lockally'
|
|
15
15
|
|
|
16
|
-
instance = Lockally::
|
|
16
|
+
instance = Lockally::ExportMailbox201Response.new(
|
|
17
17
|
url: null,
|
|
18
18
|
expires_at: null,
|
|
19
19
|
format: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Lockally::
|
|
1
|
+
# Lockally::GetCurrentAdmin200Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'lockally'
|
|
14
14
|
|
|
15
|
-
instance = Lockally::
|
|
15
|
+
instance = Lockally::GetCurrentAdmin200Response.new(
|
|
16
16
|
admin: null,
|
|
17
17
|
tenant: null
|
|
18
18
|
)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Lockally::
|
|
1
|
+
# Lockally::GetUsage200Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'lockally'
|
|
25
25
|
|
|
26
|
-
instance = Lockally::
|
|
26
|
+
instance = Lockally::GetUsage200Response.new(
|
|
27
27
|
mailboxes_active: null,
|
|
28
28
|
mailboxes_total: null,
|
|
29
29
|
domains_verified: null,
|
data/docs/HealthApi.md
CHANGED
|
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.lockally.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
7
|
+
| [**health_check**](HealthApi.md#health_check) | **GET** /healthz | Liveness check |
|
|
8
8
|
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## health_check
|
|
11
11
|
|
|
12
|
-
> <
|
|
12
|
+
> <HealthCheck200Response> health_check
|
|
13
13
|
|
|
14
14
|
Liveness check
|
|
15
15
|
|
|
@@ -25,28 +25,28 @@ api_instance = Lockally::HealthApi.new
|
|
|
25
25
|
|
|
26
26
|
begin
|
|
27
27
|
# Liveness check
|
|
28
|
-
result = api_instance.
|
|
28
|
+
result = api_instance.health_check
|
|
29
29
|
p result
|
|
30
30
|
rescue Lockally::ApiError => e
|
|
31
|
-
puts "Error when calling HealthApi->
|
|
31
|
+
puts "Error when calling HealthApi->health_check: #{e}"
|
|
32
32
|
end
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
#### Using the
|
|
35
|
+
#### Using the health_check_with_http_info variant
|
|
36
36
|
|
|
37
37
|
This returns an Array which contains the response data, status code and headers.
|
|
38
38
|
|
|
39
|
-
> <Array(<
|
|
39
|
+
> <Array(<HealthCheck200Response>, Integer, Hash)> health_check_with_http_info
|
|
40
40
|
|
|
41
41
|
```ruby
|
|
42
42
|
begin
|
|
43
43
|
# Liveness check
|
|
44
|
-
data, status_code, headers = api_instance.
|
|
44
|
+
data, status_code, headers = api_instance.health_check_with_http_info
|
|
45
45
|
p status_code # => 2xx
|
|
46
46
|
p headers # => { ... }
|
|
47
|
-
p data # => <
|
|
47
|
+
p data # => <HealthCheck200Response>
|
|
48
48
|
rescue Lockally::ApiError => e
|
|
49
|
-
puts "Error when calling HealthApi->
|
|
49
|
+
puts "Error when calling HealthApi->health_check_with_http_info: #{e}"
|
|
50
50
|
end
|
|
51
51
|
```
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ This endpoint does not need any parameter.
|
|
|
56
56
|
|
|
57
57
|
### Return type
|
|
58
58
|
|
|
59
|
-
[**
|
|
59
|
+
[**HealthCheck200Response**](HealthCheck200Response.md)
|
|
60
60
|
|
|
61
61
|
### Authorization
|
|
62
62
|
|