api-sdk-rb 1.11.111 → 1.11.133
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 +207 -381
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandKitApi.md +74 -74
- data/docs/BrandKitTokens.md +2 -0
- data/docs/BrandKitView.md +1 -1
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionsApi.md +615 -349
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreditsApi.md +20 -20
- data/docs/{CreateCompositionFromWidget201Response.md → DeleteUpload200Response.md} +3 -3
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/{OperationsIdGetResponse.md → GetOperationResponse.md} +3 -3
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnersApi.md +388 -388
- data/docs/PatchBrandKitRequest.md +2 -0
- data/docs/PublicEmbedApi.md +95 -95
- data/docs/PublicWorkflowEventsRequestEventsInner.md +3 -1
- data/docs/{GetPublicWorkflow200Response.md → PublicWorkflowResponse.md} +2 -2
- data/docs/TokensApi.md +11 -9
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +125 -125
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md} +2 -2
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md} +2 -2
- data/docs/WorkflowStats.md +4 -2
- data/docs/WorkflowsApi.md +197 -413
- data/lib/api-sdk-rb/api/brand_kit_api.rb +61 -61
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +770 -441
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +389 -389
- data/lib/api-sdk-rb/api/public_embed_api.rb +95 -95
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +132 -132
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +246 -468
- data/lib/api-sdk-rb/configuration.rb +0 -60
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{save_workspace_workflow200_response.rb → adapter_connection_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → adapter_connection_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → ai_answers_knowledge_document_response.rb} +3 -3
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +33 -2
- data/lib/api-sdk-rb/models/brand_kit_view.rb +1 -1
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → content_item_write_result_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → design_defaults_response.rb} +3 -3
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +32 -1
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +26 -4
- data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb} +3 -3
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → widget_clarification_option.rb} +40 -30
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/{create_workspace_workflow_from_preset201_response.rb → widget_plan_decisions_libraries_inner.rb} +39 -30
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → workflow_detail_response.rb} +4 -4
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +17 -5
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +32 -21
- data/spec/api/brand_kit_api_spec.rb +18 -18
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +144 -83
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +91 -91
- data/spec/api/public_embed_api_spec.rb +23 -23
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +30 -30
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +50 -89
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → account_credit_transaction_list_response_spec.rb} +6 -6
- data/spec/models/{get_public_workflow200_response_spec.rb → adapter_connection_list_response_spec.rb} +6 -6
- data/spec/models/{save_workspace_workflow200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_kit_tokens_spec.rb +6 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → brand_text_style_spec.rb} +13 -9
- data/spec/models/{get_managed_user_limits200_response_spec.rb → composition_database_record_response_spec.rb} +6 -6
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/{uploads_get200_response_spec.rb → get_operation_response_spec.rb} +6 -6
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/patch_brand_kit_request_spec.rb +6 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +10 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → widget_plan_spec.rb} +21 -9
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_stats_spec.rb +6 -0
- metadata +130 -86
- data/docs/PartnerApi.md +0 -12714
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/docs/WorkspacesApi.md +0 -1527
- data/lib/api-sdk-rb/api/partner_api.rb +0 -13791
- data/lib/api-sdk-rb/api/workspaces_api.rb +0 -1775
- data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +0 -246
- data/spec/api/partner_api_spec.rb +0 -2437
- data/spec/api/workspaces_api_spec.rb +0 -339
- data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +0 -48
- data/spec/models/create_composition_content_item201_response_spec.rb +0 -48
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +0 -48
- data/spec/models/get_partner_credit_transactions200_response_spec.rb +0 -48
- data/spec/models/get_partner_design_defaults200_response_spec.rb +0 -48
- data/spec/models/remove_user_adapter_connection200_response_spec.rb +0 -48
- data/spec/models/set_user_adapter_connection200_response_spec.rb +0 -48
data/docs/UsersApi.md
CHANGED
|
@@ -4,24 +4,24 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
7
|
+
| [**add_personal_workspace_domain**](UsersApi.md#add_personal_workspace_domain) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets |
|
|
8
|
+
| [**confirm_user_adapter_connection**](UsersApi.md#confirm_user_adapter_connection) | **POST** /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm an adapter address with the code that was emailed to it |
|
|
9
|
+
| [**create_user_api_key**](UsersApi.md#create_user_api_key) | **POST** /users/{id}/keys | Create an API key |
|
|
10
|
+
| [**delete_personal_workspace_domain**](UsersApi.md#delete_personal_workspace_domain) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets |
|
|
11
|
+
| [**delete_user_api_key**](UsersApi.md#delete_user_api_key) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key |
|
|
12
|
+
| [**get_personal_workspace_domains**](UsersApi.md#get_personal_workspace_domains) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets |
|
|
13
|
+
| [**get_user_adapter_connections**](UsersApi.md#get_user_adapter_connections) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected |
|
|
14
|
+
| [**get_user_api_key_usage_logs**](UsersApi.md#get_user_api_key_usage_logs) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for |
|
|
15
|
+
| [**get_user_api_keys**](UsersApi.md#get_user_api_keys) | **GET** /users/{id}/keys | List the API keys of an account |
|
|
16
|
+
| [**remove_user_adapter_connection**](UsersApi.md#remove_user_adapter_connection) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account |
|
|
17
|
+
| [**set_user_adapter_connection**](UsersApi.md#set_user_adapter_connection) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account |
|
|
18
|
+
| [**update_personal_workspace_domain**](UsersApi.md#update_personal_workspace_domain) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list |
|
|
19
|
+
| [**update_user_api_key**](UsersApi.md#update_user_api_key) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on |
|
|
20
20
|
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## add_personal_workspace_domain
|
|
23
23
|
|
|
24
|
-
> <PersonalWorkspaceDomainResultResponse>
|
|
24
|
+
> <PersonalWorkspaceDomainResultResponse> add_personal_workspace_domain(id, add_domain_request)
|
|
25
25
|
|
|
26
26
|
Allow a website to show your widgets
|
|
27
27
|
|
|
@@ -44,28 +44,28 @@ add_domain_request = ApiSdkRb::AddDomainRequest.new({domain: 'example.com'}) # A
|
|
|
44
44
|
|
|
45
45
|
begin
|
|
46
46
|
# Allow a website to show your widgets
|
|
47
|
-
result = api_instance.
|
|
47
|
+
result = api_instance.add_personal_workspace_domain(id, add_domain_request)
|
|
48
48
|
p result
|
|
49
49
|
rescue ApiSdkRb::ApiError => e
|
|
50
|
-
puts "Error when calling UsersApi->
|
|
50
|
+
puts "Error when calling UsersApi->add_personal_workspace_domain: #{e}"
|
|
51
51
|
end
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
#### Using the
|
|
54
|
+
#### Using the add_personal_workspace_domain_with_http_info variant
|
|
55
55
|
|
|
56
56
|
This returns an Array which contains the response data, status code and headers.
|
|
57
57
|
|
|
58
|
-
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)>
|
|
58
|
+
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> add_personal_workspace_domain_with_http_info(id, add_domain_request)
|
|
59
59
|
|
|
60
60
|
```ruby
|
|
61
61
|
begin
|
|
62
62
|
# Allow a website to show your widgets
|
|
63
|
-
data, status_code, headers = api_instance.
|
|
63
|
+
data, status_code, headers = api_instance.add_personal_workspace_domain_with_http_info(id, add_domain_request)
|
|
64
64
|
p status_code # => 2xx
|
|
65
65
|
p headers # => { ... }
|
|
66
66
|
p data # => <PersonalWorkspaceDomainResultResponse>
|
|
67
67
|
rescue ApiSdkRb::ApiError => e
|
|
68
|
-
puts "Error when calling UsersApi->
|
|
68
|
+
puts "Error when calling UsersApi->add_personal_workspace_domain_with_http_info: #{e}"
|
|
69
69
|
end
|
|
70
70
|
```
|
|
71
71
|
|
|
@@ -90,9 +90,9 @@ end
|
|
|
90
90
|
- **Accept**: application/json
|
|
91
91
|
|
|
92
92
|
|
|
93
|
-
##
|
|
93
|
+
## confirm_user_adapter_connection
|
|
94
94
|
|
|
95
|
-
> <
|
|
95
|
+
> <AdapterConnectionResponse> confirm_user_adapter_connection(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
96
96
|
|
|
97
97
|
Confirm an adapter address with the code that was emailed to it
|
|
98
98
|
|
|
@@ -117,28 +117,28 @@ confirm_adapter_connection_request = ApiSdkRb::ConfirmAdapterConnectionRequest.n
|
|
|
117
117
|
|
|
118
118
|
begin
|
|
119
119
|
# Confirm an adapter address with the code that was emailed to it
|
|
120
|
-
result = api_instance.
|
|
120
|
+
result = api_instance.confirm_user_adapter_connection(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
121
121
|
p result
|
|
122
122
|
rescue ApiSdkRb::ApiError => e
|
|
123
|
-
puts "Error when calling UsersApi->
|
|
123
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection: #{e}"
|
|
124
124
|
end
|
|
125
125
|
```
|
|
126
126
|
|
|
127
|
-
#### Using the
|
|
127
|
+
#### Using the confirm_user_adapter_connection_with_http_info variant
|
|
128
128
|
|
|
129
129
|
This returns an Array which contains the response data, status code and headers.
|
|
130
130
|
|
|
131
|
-
> <Array(<
|
|
131
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> confirm_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
132
132
|
|
|
133
133
|
```ruby
|
|
134
134
|
begin
|
|
135
135
|
# Confirm an adapter address with the code that was emailed to it
|
|
136
|
-
data, status_code, headers = api_instance.
|
|
136
|
+
data, status_code, headers = api_instance.confirm_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
137
137
|
p status_code # => 2xx
|
|
138
138
|
p headers # => { ... }
|
|
139
|
-
p data # => <
|
|
139
|
+
p data # => <AdapterConnectionResponse>
|
|
140
140
|
rescue ApiSdkRb::ApiError => e
|
|
141
|
-
puts "Error when calling UsersApi->
|
|
141
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection_with_http_info: #{e}"
|
|
142
142
|
end
|
|
143
143
|
```
|
|
144
144
|
|
|
@@ -153,7 +153,7 @@ end
|
|
|
153
153
|
|
|
154
154
|
### Return type
|
|
155
155
|
|
|
156
|
-
[**
|
|
156
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
157
157
|
|
|
158
158
|
### Authorization
|
|
159
159
|
|
|
@@ -165,9 +165,9 @@ end
|
|
|
165
165
|
- **Accept**: application/json
|
|
166
166
|
|
|
167
167
|
|
|
168
|
-
##
|
|
168
|
+
## create_user_api_key
|
|
169
169
|
|
|
170
|
-
> <CreatedUserApiKeyResponse>
|
|
170
|
+
> <CreatedUserApiKeyResponse> create_user_api_key(id, idempotency_key, create_user_api_key_request)
|
|
171
171
|
|
|
172
172
|
Create an API key
|
|
173
173
|
|
|
@@ -191,28 +191,28 @@ create_user_api_key_request = ApiSdkRb::CreateUserApiKeyRequest.new({name: 'Prod
|
|
|
191
191
|
|
|
192
192
|
begin
|
|
193
193
|
# Create an API key
|
|
194
|
-
result = api_instance.
|
|
194
|
+
result = api_instance.create_user_api_key(id, idempotency_key, create_user_api_key_request)
|
|
195
195
|
p result
|
|
196
196
|
rescue ApiSdkRb::ApiError => e
|
|
197
|
-
puts "Error when calling UsersApi->
|
|
197
|
+
puts "Error when calling UsersApi->create_user_api_key: #{e}"
|
|
198
198
|
end
|
|
199
199
|
```
|
|
200
200
|
|
|
201
|
-
#### Using the
|
|
201
|
+
#### Using the create_user_api_key_with_http_info variant
|
|
202
202
|
|
|
203
203
|
This returns an Array which contains the response data, status code and headers.
|
|
204
204
|
|
|
205
|
-
> <Array(<CreatedUserApiKeyResponse>, Integer, Hash)>
|
|
205
|
+
> <Array(<CreatedUserApiKeyResponse>, Integer, Hash)> create_user_api_key_with_http_info(id, idempotency_key, create_user_api_key_request)
|
|
206
206
|
|
|
207
207
|
```ruby
|
|
208
208
|
begin
|
|
209
209
|
# Create an API key
|
|
210
|
-
data, status_code, headers = api_instance.
|
|
210
|
+
data, status_code, headers = api_instance.create_user_api_key_with_http_info(id, idempotency_key, create_user_api_key_request)
|
|
211
211
|
p status_code # => 2xx
|
|
212
212
|
p headers # => { ... }
|
|
213
213
|
p data # => <CreatedUserApiKeyResponse>
|
|
214
214
|
rescue ApiSdkRb::ApiError => e
|
|
215
|
-
puts "Error when calling UsersApi->
|
|
215
|
+
puts "Error when calling UsersApi->create_user_api_key_with_http_info: #{e}"
|
|
216
216
|
end
|
|
217
217
|
```
|
|
218
218
|
|
|
@@ -238,9 +238,9 @@ end
|
|
|
238
238
|
- **Accept**: application/json
|
|
239
239
|
|
|
240
240
|
|
|
241
|
-
##
|
|
241
|
+
## delete_personal_workspace_domain
|
|
242
242
|
|
|
243
|
-
> <DeletePersonalWorkspaceDomainResponse>
|
|
243
|
+
> <DeletePersonalWorkspaceDomainResponse> delete_personal_workspace_domain(id, domain_id)
|
|
244
244
|
|
|
245
245
|
Stop allowing a website to show your widgets
|
|
246
246
|
|
|
@@ -263,28 +263,28 @@ domain_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `id` of the en
|
|
|
263
263
|
|
|
264
264
|
begin
|
|
265
265
|
# Stop allowing a website to show your widgets
|
|
266
|
-
result = api_instance.
|
|
266
|
+
result = api_instance.delete_personal_workspace_domain(id, domain_id)
|
|
267
267
|
p result
|
|
268
268
|
rescue ApiSdkRb::ApiError => e
|
|
269
|
-
puts "Error when calling UsersApi->
|
|
269
|
+
puts "Error when calling UsersApi->delete_personal_workspace_domain: #{e}"
|
|
270
270
|
end
|
|
271
271
|
```
|
|
272
272
|
|
|
273
|
-
#### Using the
|
|
273
|
+
#### Using the delete_personal_workspace_domain_with_http_info variant
|
|
274
274
|
|
|
275
275
|
This returns an Array which contains the response data, status code and headers.
|
|
276
276
|
|
|
277
|
-
> <Array(<DeletePersonalWorkspaceDomainResponse>, Integer, Hash)>
|
|
277
|
+
> <Array(<DeletePersonalWorkspaceDomainResponse>, Integer, Hash)> delete_personal_workspace_domain_with_http_info(id, domain_id)
|
|
278
278
|
|
|
279
279
|
```ruby
|
|
280
280
|
begin
|
|
281
281
|
# Stop allowing a website to show your widgets
|
|
282
|
-
data, status_code, headers = api_instance.
|
|
282
|
+
data, status_code, headers = api_instance.delete_personal_workspace_domain_with_http_info(id, domain_id)
|
|
283
283
|
p status_code # => 2xx
|
|
284
284
|
p headers # => { ... }
|
|
285
285
|
p data # => <DeletePersonalWorkspaceDomainResponse>
|
|
286
286
|
rescue ApiSdkRb::ApiError => e
|
|
287
|
-
puts "Error when calling UsersApi->
|
|
287
|
+
puts "Error when calling UsersApi->delete_personal_workspace_domain_with_http_info: #{e}"
|
|
288
288
|
end
|
|
289
289
|
```
|
|
290
290
|
|
|
@@ -309,9 +309,9 @@ end
|
|
|
309
309
|
- **Accept**: application/json
|
|
310
310
|
|
|
311
311
|
|
|
312
|
-
##
|
|
312
|
+
## delete_user_api_key
|
|
313
313
|
|
|
314
|
-
> <DeleteUserApiKeyResponse>
|
|
314
|
+
> <DeleteUserApiKeyResponse> delete_user_api_key(id, key_id)
|
|
315
315
|
|
|
316
316
|
Delete an API key
|
|
317
317
|
|
|
@@ -334,28 +334,28 @@ key_id = 'key_id_example' # String | The `keyId` of the key, as the list shows i
|
|
|
334
334
|
|
|
335
335
|
begin
|
|
336
336
|
# Delete an API key
|
|
337
|
-
result = api_instance.
|
|
337
|
+
result = api_instance.delete_user_api_key(id, key_id)
|
|
338
338
|
p result
|
|
339
339
|
rescue ApiSdkRb::ApiError => e
|
|
340
|
-
puts "Error when calling UsersApi->
|
|
340
|
+
puts "Error when calling UsersApi->delete_user_api_key: #{e}"
|
|
341
341
|
end
|
|
342
342
|
```
|
|
343
343
|
|
|
344
|
-
#### Using the
|
|
344
|
+
#### Using the delete_user_api_key_with_http_info variant
|
|
345
345
|
|
|
346
346
|
This returns an Array which contains the response data, status code and headers.
|
|
347
347
|
|
|
348
|
-
> <Array(<DeleteUserApiKeyResponse>, Integer, Hash)>
|
|
348
|
+
> <Array(<DeleteUserApiKeyResponse>, Integer, Hash)> delete_user_api_key_with_http_info(id, key_id)
|
|
349
349
|
|
|
350
350
|
```ruby
|
|
351
351
|
begin
|
|
352
352
|
# Delete an API key
|
|
353
|
-
data, status_code, headers = api_instance.
|
|
353
|
+
data, status_code, headers = api_instance.delete_user_api_key_with_http_info(id, key_id)
|
|
354
354
|
p status_code # => 2xx
|
|
355
355
|
p headers # => { ... }
|
|
356
356
|
p data # => <DeleteUserApiKeyResponse>
|
|
357
357
|
rescue ApiSdkRb::ApiError => e
|
|
358
|
-
puts "Error when calling UsersApi->
|
|
358
|
+
puts "Error when calling UsersApi->delete_user_api_key_with_http_info: #{e}"
|
|
359
359
|
end
|
|
360
360
|
```
|
|
361
361
|
|
|
@@ -380,9 +380,9 @@ end
|
|
|
380
380
|
- **Accept**: application/json
|
|
381
381
|
|
|
382
382
|
|
|
383
|
-
##
|
|
383
|
+
## get_personal_workspace_domains
|
|
384
384
|
|
|
385
|
-
> <GetPersonalWorkspaceDomains200Response>
|
|
385
|
+
> <GetPersonalWorkspaceDomains200Response> get_personal_workspace_domains(id)
|
|
386
386
|
|
|
387
387
|
List the websites allowed to show your widgets
|
|
388
388
|
|
|
@@ -404,28 +404,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belo
|
|
|
404
404
|
|
|
405
405
|
begin
|
|
406
406
|
# List the websites allowed to show your widgets
|
|
407
|
-
result = api_instance.
|
|
407
|
+
result = api_instance.get_personal_workspace_domains(id)
|
|
408
408
|
p result
|
|
409
409
|
rescue ApiSdkRb::ApiError => e
|
|
410
|
-
puts "Error when calling UsersApi->
|
|
410
|
+
puts "Error when calling UsersApi->get_personal_workspace_domains: #{e}"
|
|
411
411
|
end
|
|
412
412
|
```
|
|
413
413
|
|
|
414
|
-
#### Using the
|
|
414
|
+
#### Using the get_personal_workspace_domains_with_http_info variant
|
|
415
415
|
|
|
416
416
|
This returns an Array which contains the response data, status code and headers.
|
|
417
417
|
|
|
418
|
-
> <Array(<GetPersonalWorkspaceDomains200Response>, Integer, Hash)>
|
|
418
|
+
> <Array(<GetPersonalWorkspaceDomains200Response>, Integer, Hash)> get_personal_workspace_domains_with_http_info(id)
|
|
419
419
|
|
|
420
420
|
```ruby
|
|
421
421
|
begin
|
|
422
422
|
# List the websites allowed to show your widgets
|
|
423
|
-
data, status_code, headers = api_instance.
|
|
423
|
+
data, status_code, headers = api_instance.get_personal_workspace_domains_with_http_info(id)
|
|
424
424
|
p status_code # => 2xx
|
|
425
425
|
p headers # => { ... }
|
|
426
426
|
p data # => <GetPersonalWorkspaceDomains200Response>
|
|
427
427
|
rescue ApiSdkRb::ApiError => e
|
|
428
|
-
puts "Error when calling UsersApi->
|
|
428
|
+
puts "Error when calling UsersApi->get_personal_workspace_domains_with_http_info: #{e}"
|
|
429
429
|
end
|
|
430
430
|
```
|
|
431
431
|
|
|
@@ -449,9 +449,9 @@ end
|
|
|
449
449
|
- **Accept**: application/json
|
|
450
450
|
|
|
451
451
|
|
|
452
|
-
##
|
|
452
|
+
## get_user_adapter_connections
|
|
453
453
|
|
|
454
|
-
> <
|
|
454
|
+
> <AdapterConnectionListResponse> get_user_adapter_connections(user_id)
|
|
455
455
|
|
|
456
456
|
See which adapter keys an account has connected
|
|
457
457
|
|
|
@@ -473,28 +473,28 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account whose ad
|
|
|
473
473
|
|
|
474
474
|
begin
|
|
475
475
|
# See which adapter keys an account has connected
|
|
476
|
-
result = api_instance.
|
|
476
|
+
result = api_instance.get_user_adapter_connections(user_id)
|
|
477
477
|
p result
|
|
478
478
|
rescue ApiSdkRb::ApiError => e
|
|
479
|
-
puts "Error when calling UsersApi->
|
|
479
|
+
puts "Error when calling UsersApi->get_user_adapter_connections: #{e}"
|
|
480
480
|
end
|
|
481
481
|
```
|
|
482
482
|
|
|
483
|
-
#### Using the
|
|
483
|
+
#### Using the get_user_adapter_connections_with_http_info variant
|
|
484
484
|
|
|
485
485
|
This returns an Array which contains the response data, status code and headers.
|
|
486
486
|
|
|
487
|
-
> <Array(<
|
|
487
|
+
> <Array(<AdapterConnectionListResponse>, Integer, Hash)> get_user_adapter_connections_with_http_info(user_id)
|
|
488
488
|
|
|
489
489
|
```ruby
|
|
490
490
|
begin
|
|
491
491
|
# See which adapter keys an account has connected
|
|
492
|
-
data, status_code, headers = api_instance.
|
|
492
|
+
data, status_code, headers = api_instance.get_user_adapter_connections_with_http_info(user_id)
|
|
493
493
|
p status_code # => 2xx
|
|
494
494
|
p headers # => { ... }
|
|
495
|
-
p data # => <
|
|
495
|
+
p data # => <AdapterConnectionListResponse>
|
|
496
496
|
rescue ApiSdkRb::ApiError => e
|
|
497
|
-
puts "Error when calling UsersApi->
|
|
497
|
+
puts "Error when calling UsersApi->get_user_adapter_connections_with_http_info: #{e}"
|
|
498
498
|
end
|
|
499
499
|
```
|
|
500
500
|
|
|
@@ -506,7 +506,7 @@ end
|
|
|
506
506
|
|
|
507
507
|
### Return type
|
|
508
508
|
|
|
509
|
-
[**
|
|
509
|
+
[**AdapterConnectionListResponse**](AdapterConnectionListResponse.md)
|
|
510
510
|
|
|
511
511
|
### Authorization
|
|
512
512
|
|
|
@@ -518,9 +518,9 @@ end
|
|
|
518
518
|
- **Accept**: application/json
|
|
519
519
|
|
|
520
520
|
|
|
521
|
-
##
|
|
521
|
+
## get_user_api_key_usage_logs
|
|
522
522
|
|
|
523
|
-
> <GetUserApiKeyUsageLogsResponse>
|
|
523
|
+
> <GetUserApiKeyUsageLogsResponse> get_user_api_key_usage_logs(id, key_id, opts)
|
|
524
524
|
|
|
525
525
|
Read what an API key was used for
|
|
526
526
|
|
|
@@ -546,28 +546,28 @@ opts = {
|
|
|
546
546
|
|
|
547
547
|
begin
|
|
548
548
|
# Read what an API key was used for
|
|
549
|
-
result = api_instance.
|
|
549
|
+
result = api_instance.get_user_api_key_usage_logs(id, key_id, opts)
|
|
550
550
|
p result
|
|
551
551
|
rescue ApiSdkRb::ApiError => e
|
|
552
|
-
puts "Error when calling UsersApi->
|
|
552
|
+
puts "Error when calling UsersApi->get_user_api_key_usage_logs: #{e}"
|
|
553
553
|
end
|
|
554
554
|
```
|
|
555
555
|
|
|
556
|
-
#### Using the
|
|
556
|
+
#### Using the get_user_api_key_usage_logs_with_http_info variant
|
|
557
557
|
|
|
558
558
|
This returns an Array which contains the response data, status code and headers.
|
|
559
559
|
|
|
560
|
-
> <Array(<GetUserApiKeyUsageLogsResponse>, Integer, Hash)>
|
|
560
|
+
> <Array(<GetUserApiKeyUsageLogsResponse>, Integer, Hash)> get_user_api_key_usage_logs_with_http_info(id, key_id, opts)
|
|
561
561
|
|
|
562
562
|
```ruby
|
|
563
563
|
begin
|
|
564
564
|
# Read what an API key was used for
|
|
565
|
-
data, status_code, headers = api_instance.
|
|
565
|
+
data, status_code, headers = api_instance.get_user_api_key_usage_logs_with_http_info(id, key_id, opts)
|
|
566
566
|
p status_code # => 2xx
|
|
567
567
|
p headers # => { ... }
|
|
568
568
|
p data # => <GetUserApiKeyUsageLogsResponse>
|
|
569
569
|
rescue ApiSdkRb::ApiError => e
|
|
570
|
-
puts "Error when calling UsersApi->
|
|
570
|
+
puts "Error when calling UsersApi->get_user_api_key_usage_logs_with_http_info: #{e}"
|
|
571
571
|
end
|
|
572
572
|
```
|
|
573
573
|
|
|
@@ -593,9 +593,9 @@ end
|
|
|
593
593
|
- **Accept**: application/json
|
|
594
594
|
|
|
595
595
|
|
|
596
|
-
##
|
|
596
|
+
## get_user_api_keys
|
|
597
597
|
|
|
598
|
-
> <GetUserApiKeys200Response>
|
|
598
|
+
> <GetUserApiKeys200Response> get_user_api_keys(id)
|
|
599
599
|
|
|
600
600
|
List the API keys of an account
|
|
601
601
|
|
|
@@ -617,28 +617,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the keys belo
|
|
|
617
617
|
|
|
618
618
|
begin
|
|
619
619
|
# List the API keys of an account
|
|
620
|
-
result = api_instance.
|
|
620
|
+
result = api_instance.get_user_api_keys(id)
|
|
621
621
|
p result
|
|
622
622
|
rescue ApiSdkRb::ApiError => e
|
|
623
|
-
puts "Error when calling UsersApi->
|
|
623
|
+
puts "Error when calling UsersApi->get_user_api_keys: #{e}"
|
|
624
624
|
end
|
|
625
625
|
```
|
|
626
626
|
|
|
627
|
-
#### Using the
|
|
627
|
+
#### Using the get_user_api_keys_with_http_info variant
|
|
628
628
|
|
|
629
629
|
This returns an Array which contains the response data, status code and headers.
|
|
630
630
|
|
|
631
|
-
> <Array(<GetUserApiKeys200Response>, Integer, Hash)>
|
|
631
|
+
> <Array(<GetUserApiKeys200Response>, Integer, Hash)> get_user_api_keys_with_http_info(id)
|
|
632
632
|
|
|
633
633
|
```ruby
|
|
634
634
|
begin
|
|
635
635
|
# List the API keys of an account
|
|
636
|
-
data, status_code, headers = api_instance.
|
|
636
|
+
data, status_code, headers = api_instance.get_user_api_keys_with_http_info(id)
|
|
637
637
|
p status_code # => 2xx
|
|
638
638
|
p headers # => { ... }
|
|
639
639
|
p data # => <GetUserApiKeys200Response>
|
|
640
640
|
rescue ApiSdkRb::ApiError => e
|
|
641
|
-
puts "Error when calling UsersApi->
|
|
641
|
+
puts "Error when calling UsersApi->get_user_api_keys_with_http_info: #{e}"
|
|
642
642
|
end
|
|
643
643
|
```
|
|
644
644
|
|
|
@@ -662,9 +662,9 @@ end
|
|
|
662
662
|
- **Accept**: application/json
|
|
663
663
|
|
|
664
664
|
|
|
665
|
-
##
|
|
665
|
+
## remove_user_adapter_connection
|
|
666
666
|
|
|
667
|
-
> <
|
|
667
|
+
> <AdapterConnectionRemovalResponse> remove_user_adapter_connection(user_id, adapter_id, credential_key)
|
|
668
668
|
|
|
669
669
|
Remove an adapter key from an account
|
|
670
670
|
|
|
@@ -688,28 +688,28 @@ credential_key = 'credential_key_example' # String | The key's name within the a
|
|
|
688
688
|
|
|
689
689
|
begin
|
|
690
690
|
# Remove an adapter key from an account
|
|
691
|
-
result = api_instance.
|
|
691
|
+
result = api_instance.remove_user_adapter_connection(user_id, adapter_id, credential_key)
|
|
692
692
|
p result
|
|
693
693
|
rescue ApiSdkRb::ApiError => e
|
|
694
|
-
puts "Error when calling UsersApi->
|
|
694
|
+
puts "Error when calling UsersApi->remove_user_adapter_connection: #{e}"
|
|
695
695
|
end
|
|
696
696
|
```
|
|
697
697
|
|
|
698
|
-
#### Using the
|
|
698
|
+
#### Using the remove_user_adapter_connection_with_http_info variant
|
|
699
699
|
|
|
700
700
|
This returns an Array which contains the response data, status code and headers.
|
|
701
701
|
|
|
702
|
-
> <Array(<
|
|
702
|
+
> <Array(<AdapterConnectionRemovalResponse>, Integer, Hash)> remove_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key)
|
|
703
703
|
|
|
704
704
|
```ruby
|
|
705
705
|
begin
|
|
706
706
|
# Remove an adapter key from an account
|
|
707
|
-
data, status_code, headers = api_instance.
|
|
707
|
+
data, status_code, headers = api_instance.remove_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key)
|
|
708
708
|
p status_code # => 2xx
|
|
709
709
|
p headers # => { ... }
|
|
710
|
-
p data # => <
|
|
710
|
+
p data # => <AdapterConnectionRemovalResponse>
|
|
711
711
|
rescue ApiSdkRb::ApiError => e
|
|
712
|
-
puts "Error when calling UsersApi->
|
|
712
|
+
puts "Error when calling UsersApi->remove_user_adapter_connection_with_http_info: #{e}"
|
|
713
713
|
end
|
|
714
714
|
```
|
|
715
715
|
|
|
@@ -723,7 +723,7 @@ end
|
|
|
723
723
|
|
|
724
724
|
### Return type
|
|
725
725
|
|
|
726
|
-
[**
|
|
726
|
+
[**AdapterConnectionRemovalResponse**](AdapterConnectionRemovalResponse.md)
|
|
727
727
|
|
|
728
728
|
### Authorization
|
|
729
729
|
|
|
@@ -735,9 +735,9 @@ end
|
|
|
735
735
|
- **Accept**: application/json
|
|
736
736
|
|
|
737
737
|
|
|
738
|
-
##
|
|
738
|
+
## set_user_adapter_connection
|
|
739
739
|
|
|
740
|
-
> <
|
|
740
|
+
> <AdapterConnectionResponse> set_user_adapter_connection(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
741
741
|
|
|
742
742
|
Connect an adapter key to an account
|
|
743
743
|
|
|
@@ -762,28 +762,28 @@ set_adapter_connection_request = ApiSdkRb::SetAdapterConnectionRequest.new({cred
|
|
|
762
762
|
|
|
763
763
|
begin
|
|
764
764
|
# Connect an adapter key to an account
|
|
765
|
-
result = api_instance.
|
|
765
|
+
result = api_instance.set_user_adapter_connection(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
766
766
|
p result
|
|
767
767
|
rescue ApiSdkRb::ApiError => e
|
|
768
|
-
puts "Error when calling UsersApi->
|
|
768
|
+
puts "Error when calling UsersApi->set_user_adapter_connection: #{e}"
|
|
769
769
|
end
|
|
770
770
|
```
|
|
771
771
|
|
|
772
|
-
#### Using the
|
|
772
|
+
#### Using the set_user_adapter_connection_with_http_info variant
|
|
773
773
|
|
|
774
774
|
This returns an Array which contains the response data, status code and headers.
|
|
775
775
|
|
|
776
|
-
> <Array(<
|
|
776
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> set_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
777
777
|
|
|
778
778
|
```ruby
|
|
779
779
|
begin
|
|
780
780
|
# Connect an adapter key to an account
|
|
781
|
-
data, status_code, headers = api_instance.
|
|
781
|
+
data, status_code, headers = api_instance.set_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
782
782
|
p status_code # => 2xx
|
|
783
783
|
p headers # => { ... }
|
|
784
|
-
p data # => <
|
|
784
|
+
p data # => <AdapterConnectionResponse>
|
|
785
785
|
rescue ApiSdkRb::ApiError => e
|
|
786
|
-
puts "Error when calling UsersApi->
|
|
786
|
+
puts "Error when calling UsersApi->set_user_adapter_connection_with_http_info: #{e}"
|
|
787
787
|
end
|
|
788
788
|
```
|
|
789
789
|
|
|
@@ -798,7 +798,7 @@ end
|
|
|
798
798
|
|
|
799
799
|
### Return type
|
|
800
800
|
|
|
801
|
-
[**
|
|
801
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
802
802
|
|
|
803
803
|
### Authorization
|
|
804
804
|
|
|
@@ -810,9 +810,9 @@ end
|
|
|
810
810
|
- **Accept**: application/json
|
|
811
811
|
|
|
812
812
|
|
|
813
|
-
##
|
|
813
|
+
## update_personal_workspace_domain
|
|
814
814
|
|
|
815
|
-
> <PersonalWorkspaceDomainResultResponse>
|
|
815
|
+
> <PersonalWorkspaceDomainResultResponse> update_personal_workspace_domain(id, domain_id, update_domain_request)
|
|
816
816
|
|
|
817
817
|
Change a website on your list
|
|
818
818
|
|
|
@@ -836,28 +836,28 @@ update_domain_request = ApiSdkRb::UpdateDomainRequest.new({domain: 'example.com'
|
|
|
836
836
|
|
|
837
837
|
begin
|
|
838
838
|
# Change a website on your list
|
|
839
|
-
result = api_instance.
|
|
839
|
+
result = api_instance.update_personal_workspace_domain(id, domain_id, update_domain_request)
|
|
840
840
|
p result
|
|
841
841
|
rescue ApiSdkRb::ApiError => e
|
|
842
|
-
puts "Error when calling UsersApi->
|
|
842
|
+
puts "Error when calling UsersApi->update_personal_workspace_domain: #{e}"
|
|
843
843
|
end
|
|
844
844
|
```
|
|
845
845
|
|
|
846
|
-
#### Using the
|
|
846
|
+
#### Using the update_personal_workspace_domain_with_http_info variant
|
|
847
847
|
|
|
848
848
|
This returns an Array which contains the response data, status code and headers.
|
|
849
849
|
|
|
850
|
-
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)>
|
|
850
|
+
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> update_personal_workspace_domain_with_http_info(id, domain_id, update_domain_request)
|
|
851
851
|
|
|
852
852
|
```ruby
|
|
853
853
|
begin
|
|
854
854
|
# Change a website on your list
|
|
855
|
-
data, status_code, headers = api_instance.
|
|
855
|
+
data, status_code, headers = api_instance.update_personal_workspace_domain_with_http_info(id, domain_id, update_domain_request)
|
|
856
856
|
p status_code # => 2xx
|
|
857
857
|
p headers # => { ... }
|
|
858
858
|
p data # => <PersonalWorkspaceDomainResultResponse>
|
|
859
859
|
rescue ApiSdkRb::ApiError => e
|
|
860
|
-
puts "Error when calling UsersApi->
|
|
860
|
+
puts "Error when calling UsersApi->update_personal_workspace_domain_with_http_info: #{e}"
|
|
861
861
|
end
|
|
862
862
|
```
|
|
863
863
|
|
|
@@ -883,9 +883,9 @@ end
|
|
|
883
883
|
- **Accept**: application/json
|
|
884
884
|
|
|
885
885
|
|
|
886
|
-
##
|
|
886
|
+
## update_user_api_key
|
|
887
887
|
|
|
888
|
-
> <UserApiKeyResponse>
|
|
888
|
+
> <UserApiKeyResponse> update_user_api_key(id, key_id, update_user_api_key_request)
|
|
889
889
|
|
|
890
890
|
Rename an API key, or switch it off or on
|
|
891
891
|
|
|
@@ -909,28 +909,28 @@ update_user_api_key_request = ApiSdkRb::UpdateUserApiKeyRequest.new # UpdateUser
|
|
|
909
909
|
|
|
910
910
|
begin
|
|
911
911
|
# Rename an API key, or switch it off or on
|
|
912
|
-
result = api_instance.
|
|
912
|
+
result = api_instance.update_user_api_key(id, key_id, update_user_api_key_request)
|
|
913
913
|
p result
|
|
914
914
|
rescue ApiSdkRb::ApiError => e
|
|
915
|
-
puts "Error when calling UsersApi->
|
|
915
|
+
puts "Error when calling UsersApi->update_user_api_key: #{e}"
|
|
916
916
|
end
|
|
917
917
|
```
|
|
918
918
|
|
|
919
|
-
#### Using the
|
|
919
|
+
#### Using the update_user_api_key_with_http_info variant
|
|
920
920
|
|
|
921
921
|
This returns an Array which contains the response data, status code and headers.
|
|
922
922
|
|
|
923
|
-
> <Array(<UserApiKeyResponse>, Integer, Hash)>
|
|
923
|
+
> <Array(<UserApiKeyResponse>, Integer, Hash)> update_user_api_key_with_http_info(id, key_id, update_user_api_key_request)
|
|
924
924
|
|
|
925
925
|
```ruby
|
|
926
926
|
begin
|
|
927
927
|
# Rename an API key, or switch it off or on
|
|
928
|
-
data, status_code, headers = api_instance.
|
|
928
|
+
data, status_code, headers = api_instance.update_user_api_key_with_http_info(id, key_id, update_user_api_key_request)
|
|
929
929
|
p status_code # => 2xx
|
|
930
930
|
p headers # => { ... }
|
|
931
931
|
p data # => <UserApiKeyResponse>
|
|
932
932
|
rescue ApiSdkRb::ApiError => e
|
|
933
|
-
puts "Error when calling UsersApi->
|
|
933
|
+
puts "Error when calling UsersApi->update_user_api_key_with_http_info: #{e}"
|
|
934
934
|
end
|
|
935
935
|
```
|
|
936
936
|
|