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/ManagedUsersApi.md
CHANGED
|
@@ -4,28 +4,29 @@ 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
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
7
|
+
| [**copy_preset_for_managed_user**](ManagedUsersApi.md#copy_preset_for_managed_user) | **POST** /managed-users/{id}/presets/{key}/copy | Give a managed user a copy of one of your presets |
|
|
8
|
+
| [**create_composition_from_preset**](ManagedUsersApi.md#create_composition_from_preset) | **POST** /managed-users/{id}/presets/{key}/composition | Create a composition from one of your presets in one call |
|
|
9
|
+
| [**create_managed_user**](ManagedUsersApi.md#create_managed_user) | **POST** /managed-users | Create Managed User |
|
|
10
|
+
| [**create_managed_user_editor_session**](ManagedUsersApi.md#create_managed_user_editor_session) | **POST** /managed-users/{id}/editor-sessions | Create an editor session for a managed user |
|
|
11
|
+
| [**delete_managed_user**](ManagedUsersApi.md#delete_managed_user) | **DELETE** /managed-users/{id} | Delete Managed User |
|
|
12
|
+
| [**get_all_managed_users**](ManagedUsersApi.md#get_all_managed_users) | **GET** /managed-users | Get Managed Users |
|
|
13
|
+
| [**get_managed_user_by_id**](ManagedUsersApi.md#get_managed_user_by_id) | **GET** /managed-users/{id} | Get Managed User By ID |
|
|
14
|
+
| [**get_managed_user_design_defaults**](ManagedUsersApi.md#get_managed_user_design_defaults) | **GET** /managed-users/{id}/design-defaults | Read design defaults for one managed user |
|
|
15
|
+
| [**get_managed_user_limits**](ManagedUsersApi.md#get_managed_user_limits) | **GET** /managed-users/{id}/limits | Read monthly credit cap and usage for one managed user |
|
|
16
|
+
| [**get_managed_user_storage_usage**](ManagedUsersApi.md#get_managed_user_storage_usage) | **GET** /managed-users/{id}/storage-usage | Storage used by one managed user's uploads |
|
|
17
|
+
| [**get_managed_user_usage**](ManagedUsersApi.md#get_managed_user_usage) | **GET** /managed-users/{id}/usage | What a managed user's editor sessions spent |
|
|
18
|
+
| [**get_managed_users_by_manager_id**](ManagedUsersApi.md#get_managed_users_by_manager_id) | **GET** /users/{managerId}/managed-users | Get Managed Users By Manager |
|
|
19
|
+
| [**list_managed_user_entries**](ManagedUsersApi.md#list_managed_user_entries) | **GET** /managed-users/{id}/entries | List entries across a managed user's compositions |
|
|
20
|
+
| [**revoke_managed_user_editor_session**](ManagedUsersApi.md#revoke_managed_user_editor_session) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user |
|
|
21
|
+
| [**revoke_managed_user_editor_sessions**](ManagedUsersApi.md#revoke_managed_user_editor_sessions) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user |
|
|
22
|
+
| [**set_managed_user_design_defaults**](ManagedUsersApi.md#set_managed_user_design_defaults) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user |
|
|
23
|
+
| [**set_managed_user_limits**](ManagedUsersApi.md#set_managed_user_limits) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user |
|
|
24
|
+
| [**update_managed_user**](ManagedUsersApi.md#update_managed_user) | **PUT** /managed-users/{id} | Update Managed User |
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## copy_preset_for_managed_user
|
|
28
|
+
|
|
29
|
+
> <PartnerPresetCopyResponse> copy_preset_for_managed_user(id, key, idempotency_key, opts)
|
|
29
30
|
|
|
30
31
|
Give a managed user a copy of one of your presets
|
|
31
32
|
|
|
@@ -52,28 +53,28 @@ opts = {
|
|
|
52
53
|
|
|
53
54
|
begin
|
|
54
55
|
# Give a managed user a copy of one of your presets
|
|
55
|
-
result = api_instance.
|
|
56
|
+
result = api_instance.copy_preset_for_managed_user(id, key, idempotency_key, opts)
|
|
56
57
|
p result
|
|
57
58
|
rescue ApiSdkRb::ApiError => e
|
|
58
|
-
puts "Error when calling ManagedUsersApi->
|
|
59
|
+
puts "Error when calling ManagedUsersApi->copy_preset_for_managed_user: #{e}"
|
|
59
60
|
end
|
|
60
61
|
```
|
|
61
62
|
|
|
62
|
-
#### Using the
|
|
63
|
+
#### Using the copy_preset_for_managed_user_with_http_info variant
|
|
63
64
|
|
|
64
65
|
This returns an Array which contains the response data, status code and headers.
|
|
65
66
|
|
|
66
|
-
> <Array(<PartnerPresetCopyResponse>, Integer, Hash)>
|
|
67
|
+
> <Array(<PartnerPresetCopyResponse>, Integer, Hash)> copy_preset_for_managed_user_with_http_info(id, key, idempotency_key, opts)
|
|
67
68
|
|
|
68
69
|
```ruby
|
|
69
70
|
begin
|
|
70
71
|
# Give a managed user a copy of one of your presets
|
|
71
|
-
data, status_code, headers = api_instance.
|
|
72
|
+
data, status_code, headers = api_instance.copy_preset_for_managed_user_with_http_info(id, key, idempotency_key, opts)
|
|
72
73
|
p status_code # => 2xx
|
|
73
74
|
p headers # => { ... }
|
|
74
75
|
p data # => <PartnerPresetCopyResponse>
|
|
75
76
|
rescue ApiSdkRb::ApiError => e
|
|
76
|
-
puts "Error when calling ManagedUsersApi->
|
|
77
|
+
puts "Error when calling ManagedUsersApi->copy_preset_for_managed_user_with_http_info: #{e}"
|
|
77
78
|
end
|
|
78
79
|
```
|
|
79
80
|
|
|
@@ -100,9 +101,9 @@ end
|
|
|
100
101
|
- **Accept**: application/json
|
|
101
102
|
|
|
102
103
|
|
|
103
|
-
##
|
|
104
|
+
## create_composition_from_preset
|
|
104
105
|
|
|
105
|
-
> <
|
|
106
|
+
> <CompositionResponse> create_composition_from_preset(id, key, idempotency_key, create_composition_from_preset_request)
|
|
106
107
|
|
|
107
108
|
Create a composition from one of your presets in one call
|
|
108
109
|
|
|
@@ -127,28 +128,28 @@ create_composition_from_preset_request = ApiSdkRb::CreateCompositionFromPresetRe
|
|
|
127
128
|
|
|
128
129
|
begin
|
|
129
130
|
# Create a composition from one of your presets in one call
|
|
130
|
-
result = api_instance.
|
|
131
|
+
result = api_instance.create_composition_from_preset(id, key, idempotency_key, create_composition_from_preset_request)
|
|
131
132
|
p result
|
|
132
133
|
rescue ApiSdkRb::ApiError => e
|
|
133
|
-
puts "Error when calling ManagedUsersApi->
|
|
134
|
+
puts "Error when calling ManagedUsersApi->create_composition_from_preset: #{e}"
|
|
134
135
|
end
|
|
135
136
|
```
|
|
136
137
|
|
|
137
|
-
#### Using the
|
|
138
|
+
#### Using the create_composition_from_preset_with_http_info variant
|
|
138
139
|
|
|
139
140
|
This returns an Array which contains the response data, status code and headers.
|
|
140
141
|
|
|
141
|
-
> <Array(<
|
|
142
|
+
> <Array(<CompositionResponse>, Integer, Hash)> create_composition_from_preset_with_http_info(id, key, idempotency_key, create_composition_from_preset_request)
|
|
142
143
|
|
|
143
144
|
```ruby
|
|
144
145
|
begin
|
|
145
146
|
# Create a composition from one of your presets in one call
|
|
146
|
-
data, status_code, headers = api_instance.
|
|
147
|
+
data, status_code, headers = api_instance.create_composition_from_preset_with_http_info(id, key, idempotency_key, create_composition_from_preset_request)
|
|
147
148
|
p status_code # => 2xx
|
|
148
149
|
p headers # => { ... }
|
|
149
|
-
p data # => <
|
|
150
|
+
p data # => <CompositionResponse>
|
|
150
151
|
rescue ApiSdkRb::ApiError => e
|
|
151
|
-
puts "Error when calling ManagedUsersApi->
|
|
152
|
+
puts "Error when calling ManagedUsersApi->create_composition_from_preset_with_http_info: #{e}"
|
|
152
153
|
end
|
|
153
154
|
```
|
|
154
155
|
|
|
@@ -163,7 +164,7 @@ end
|
|
|
163
164
|
|
|
164
165
|
### Return type
|
|
165
166
|
|
|
166
|
-
[**
|
|
167
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
167
168
|
|
|
168
169
|
### Authorization
|
|
169
170
|
|
|
@@ -175,9 +176,9 @@ end
|
|
|
175
176
|
- **Accept**: application/json
|
|
176
177
|
|
|
177
178
|
|
|
178
|
-
##
|
|
179
|
+
## create_managed_user
|
|
179
180
|
|
|
180
|
-
> <ManagedUserResponse>
|
|
181
|
+
> <ManagedUserResponse> create_managed_user(idempotency_key, new_managed_user)
|
|
181
182
|
|
|
182
183
|
Create Managed User
|
|
183
184
|
|
|
@@ -200,28 +201,28 @@ new_managed_user = ApiSdkRb::NewManagedUser.new({external_id: 'external-user-123
|
|
|
200
201
|
|
|
201
202
|
begin
|
|
202
203
|
# Create Managed User
|
|
203
|
-
result = api_instance.
|
|
204
|
+
result = api_instance.create_managed_user(idempotency_key, new_managed_user)
|
|
204
205
|
p result
|
|
205
206
|
rescue ApiSdkRb::ApiError => e
|
|
206
|
-
puts "Error when calling ManagedUsersApi->
|
|
207
|
+
puts "Error when calling ManagedUsersApi->create_managed_user: #{e}"
|
|
207
208
|
end
|
|
208
209
|
```
|
|
209
210
|
|
|
210
|
-
#### Using the
|
|
211
|
+
#### Using the create_managed_user_with_http_info variant
|
|
211
212
|
|
|
212
213
|
This returns an Array which contains the response data, status code and headers.
|
|
213
214
|
|
|
214
|
-
> <Array(<ManagedUserResponse>, Integer, Hash)>
|
|
215
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> create_managed_user_with_http_info(idempotency_key, new_managed_user)
|
|
215
216
|
|
|
216
217
|
```ruby
|
|
217
218
|
begin
|
|
218
219
|
# Create Managed User
|
|
219
|
-
data, status_code, headers = api_instance.
|
|
220
|
+
data, status_code, headers = api_instance.create_managed_user_with_http_info(idempotency_key, new_managed_user)
|
|
220
221
|
p status_code # => 2xx
|
|
221
222
|
p headers # => { ... }
|
|
222
223
|
p data # => <ManagedUserResponse>
|
|
223
224
|
rescue ApiSdkRb::ApiError => e
|
|
224
|
-
puts "Error when calling ManagedUsersApi->
|
|
225
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_with_http_info: #{e}"
|
|
225
226
|
end
|
|
226
227
|
```
|
|
227
228
|
|
|
@@ -246,13 +247,13 @@ end
|
|
|
246
247
|
- **Accept**: application/json
|
|
247
248
|
|
|
248
249
|
|
|
249
|
-
##
|
|
250
|
+
## create_managed_user_editor_session
|
|
250
251
|
|
|
251
|
-
> <EditorSessionResponse>
|
|
252
|
+
> <EditorSessionResponse> create_managed_user_editor_session(id, new_editor_session)
|
|
252
253
|
|
|
253
254
|
Create an editor session for a managed user
|
|
254
255
|
|
|
255
|
-
Makes a short-lived credential that lets the browser of ONE of your managed users use Widgetic's editor pieces, such as the File Browser and the composition editor, without your API key ever reaching that browser. Call this from your server when the page that hosts the editor opens, and hand the `token` in the answer to that page. The token is shown once. It starts with `wgt_ses_` and the browser sends it as `Authorization: Bearer <token>`. It can do only what the `surfaces` you name allow, and only for this managed user: - `files`: upload a file (`
|
|
256
|
+
Makes a short-lived credential that lets the browser of ONE of your managed users use Widgetic's editor pieces, such as the File Browser and the composition editor, without your API key ever reaching that browser. Call this from your server when the page that hosts the editor opens, and hand the `token` in the answer to that page. The token is shown once. It starts with `wgt_ses_` and the browser sends it as `Authorization: Bearer <token>`. It can do only what the `surfaces` you name allow, and only for this managed user: - `files`: upload a file (`uploadFile`) and list the files uploaded for this user (`listUploads`). Every file is filed for this user and stored in your own storage destination, never in Widgetic's: a file a customer uploads is yours to keep, and takes none of your storage allowance. Partner storage is not optional, so no session, whatever its surfaces, can be made until you have set a destination (`setPartnerStorageDestination`); until then it is refused with 409 and `PARTNER_STORAGE_REQUIRED`, and when the destination cannot be used with 503 and `STORAGE_DESTINATION_UNAVAILABLE`. A destination you remove after the session was made stops its uploads too (the same 409; the browser is only told that the feature is not available right now). To keep a customer from uploading, leave `files` out of the session and hand the editors your own media library instead (`mediaLibrary`). - `editor`: edit one of this user's compositions: read it (`getCompositionById`, its content, design, embed settings and schemas), check a content change (`validateCompositionContent`), and change its name, content, design and embed settings (`updateComposition`, `setDynamicContent`). For a widget that answers visitors' questions from documents (the `ai-answers` adapter), it also lists those documents, adds one as text or as a file (a text file or a picture; a PDF once PDFs are read), and removes one (`getAiAnswersKnowledge`, `addAiAnswersKnowledgeDocument`, `addAiAnswersKnowledgeFile`, `removeAiAnswersKnowledgeDocument`); adding costs no credits, and is limited for each of your users separately. It can reach only compositions you created for this managed user (tag them with `managedUserId` when you create them); any other composition, including another of your users', answers 404. - `creator`: use Widgetic's widget creator for this user, including its AI. Draw on canvases and save them (`getAllCanvases`, `getCanvas`, `createCanvas`, `updateCanvas`, `previewDeleteCanvas`, `deleteCanvas`); make, change, copy and delete the widgets on them (`createWidget`, `getWidgets`, `getWidgetsBatch`, `updateWidget`, `uploadWidgetThumbnail`, `duplicateWidget`, `deleteWidget`); list and make the compositions of a widget it built (`getAllCompositions`, `createComposition`), which is how it shows the widget with sample values; keep the conversation of each widget (`getConversationsByWidgetId`, `createConversationForWidget`, `updateConversation`, `getMessages`, `createMessage`, `updateMessage`, `restoreCheckpoint`); and read a widget's schemas and give it its repository (`getWidgetContentSchema`, `getWidgetDesignSchema`, `updateWidgetRepository`). The AI that builds a widget is part of it: list the models (`listLlmModels`), open the widget's repository (`createRepository`, `getRepository`), start a generation and follow or cancel it (`generateCode`, `streamOperationUpdates`, `getOperation`, `cancelOperation`), build and preview the result (`getWidgetRepositoryHead`, `buildWidgetFromRepo`, `previewWidgetVersion`), publish a version of the widget and move between its versions (`publishBuiltWidget`, `getWidgetPublishHistory`, `setWidgetPublishHistoryLive`, `renameWidgetPublishHistoryTitle`), and turn a stroke or a sentence into a decision (`recognizeShape`, `resolveDesignProperty`). It can also offer the customer your presets as starting points: read them and ask for a copy for this customer (`listMyPresets`, `copyMyPreset`; you choose the presets with `setPartnerPreset`). What the session makes is filed for this managed user, and the lists it reads hold only this user's canvases, widgets and compositions. It can reach only canvases, widgets, compositions, repositories, uploaded files and operations made for this managed user (tag the canvases and widgets you create with `managedUserId`); any other canvas, widget, composition, conversation, message, repository, file or operation, including another of your users', answers 404. The creator also saves the composition it is editing (`updateComposition`, from the `editor` surface) and attaches pictures to its chat (`uploadFile`, from the `files` surface), and the surfaces do not imply one another: to open the whole creator for a user, ask for `creator`, `editor` and `files` together. A generation or a build one user starts can be followed and cancelled by that user and by you, never by another of your users. The AI is paid for by your account, as your own calls are: its credits and allowances are yours. A session cannot make a widget public (publishing a version does not), file one under a project or an organization, or set anything the creator does not set: a body with another field is refused with 403 and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. - `workflows`: use Widgetic's Workflows editor for this user. List their workflows and the compositions a workflow of theirs can chain (`listWorkspaceWorkflows`, `listWorkspaceWorkflowCompositionOptions`); list the starting points you offer them and make a workflow from one, which gives the user their own copy of every widget it chains, a composition of their own on each copy, and a draft (`listWorkspaceWorkflowPresets`, `createWorkspaceWorkflowFromPreset`; you offer them with `setPartnerWorkflowPreset`); make, open, change and delete one (`createWorkspaceWorkflow`, `getWorkspaceWorkflow`, `saveWorkspaceWorkflow`, `deleteWorkspaceWorkflow`) and copy it (`duplicateWorkspaceWorkflow`); publish it or discard the changes of its draft (`publishWorkspaceWorkflow`, `discardWorkspaceWorkflowChanges`); read and restore its versions (`listWorkspaceWorkflowVersions`, `getWorkspaceWorkflowVersion`, `restoreWorkspaceWorkflowVersion`); pause, resume, archive and unarchive it (`pauseWorkspaceWorkflow`, `resumeWorkspaceWorkflow`, `archiveWorkspaceWorkflow`, `unarchiveWorkspaceWorkflow`); and read its counts (`getWorkspaceWorkflowStats`). The workspace in each path is `personal`: a session has no other, and a path that names an organization is refused. What the session makes is filed for this managed user (`managedUserId`), the lists hold only this user's workflows, and it can reach only workflows made for this managed user; any other workflow, including one of yours or of another of your users, answers 404. A workflow can chain only the compositions you made for this managed user (tag them with `managedUserId`): one that belongs to anybody else is not available, and publishing a workflow that uses it is refused. A customer can have at most 50 workflows, and what a customer's session reads never says who published a version. A session cannot set who a workflow belongs to or which workspace it is in: a body with another field is refused with 403 and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. Everything else is refused with 403 and `EDITOR_SESSION_ROUTE_NOT_ALLOWED`: a session cannot read your account, make more sessions, change your presets or delete a composition, and a session without the `creator` surface cannot create or list compositions. Create the composition yourself with your API key, then open the editor on it. A session ends at `expiresAt` (at most four hours), when you end it (`revokeManagedUserEditorSession`), or when the managed user is switched off or deleted. A managed user can have at most 100 live sessions at once (`429 EDITOR_SESSION_LIMIT_REACHED`). A session that is bound to a web page (`allowedOrigin`) is refused from any other origin. The AI the session runs is paid for with your credits. Set `maxCredits` to hold the session to a number of them: once its generations have taken that many (a generation that fails is refunded and does not count), the next one is refused with 402 and `EDITOR_SESSION_CREDIT_LIMIT_REACHED`, and the browser is told only that the feature is not available right now. Without it, the limit Widgetic has set for your account applies when it has set one (the same limit for every session you make, and `maxCredits: null` asks for none), and otherwise the credits of your account are the only ceiling. What each of your users' sessions has spent is in `getManagedUserUsage`. Each call makes a new session. It does not take an `Idempotency-Key`: the answer holds the token, and the token is never stored where a retry could read it back. The answer is sent with `Cache-Control: no-store`.
|
|
256
257
|
|
|
257
258
|
### Examples
|
|
258
259
|
|
|
@@ -271,28 +272,28 @@ new_editor_session = ApiSdkRb::NewEditorSession.new({surfaces: ["files", "editor
|
|
|
271
272
|
|
|
272
273
|
begin
|
|
273
274
|
# Create an editor session for a managed user
|
|
274
|
-
result = api_instance.
|
|
275
|
+
result = api_instance.create_managed_user_editor_session(id, new_editor_session)
|
|
275
276
|
p result
|
|
276
277
|
rescue ApiSdkRb::ApiError => e
|
|
277
|
-
puts "Error when calling ManagedUsersApi->
|
|
278
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_editor_session: #{e}"
|
|
278
279
|
end
|
|
279
280
|
```
|
|
280
281
|
|
|
281
|
-
#### Using the
|
|
282
|
+
#### Using the create_managed_user_editor_session_with_http_info variant
|
|
282
283
|
|
|
283
284
|
This returns an Array which contains the response data, status code and headers.
|
|
284
285
|
|
|
285
|
-
> <Array(<EditorSessionResponse>, Integer, Hash)>
|
|
286
|
+
> <Array(<EditorSessionResponse>, Integer, Hash)> create_managed_user_editor_session_with_http_info(id, new_editor_session)
|
|
286
287
|
|
|
287
288
|
```ruby
|
|
288
289
|
begin
|
|
289
290
|
# Create an editor session for a managed user
|
|
290
|
-
data, status_code, headers = api_instance.
|
|
291
|
+
data, status_code, headers = api_instance.create_managed_user_editor_session_with_http_info(id, new_editor_session)
|
|
291
292
|
p status_code # => 2xx
|
|
292
293
|
p headers # => { ... }
|
|
293
294
|
p data # => <EditorSessionResponse>
|
|
294
295
|
rescue ApiSdkRb::ApiError => e
|
|
295
|
-
puts "Error when calling ManagedUsersApi->
|
|
296
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_editor_session_with_http_info: #{e}"
|
|
296
297
|
end
|
|
297
298
|
```
|
|
298
299
|
|
|
@@ -317,9 +318,9 @@ end
|
|
|
317
318
|
- **Accept**: application/json
|
|
318
319
|
|
|
319
320
|
|
|
320
|
-
##
|
|
321
|
+
## delete_managed_user
|
|
321
322
|
|
|
322
|
-
> <
|
|
323
|
+
> <ManagedUserRemovalResponse> delete_managed_user(id)
|
|
323
324
|
|
|
324
325
|
Delete Managed User
|
|
325
326
|
|
|
@@ -341,28 +342,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the managed user to
|
|
|
341
342
|
|
|
342
343
|
begin
|
|
343
344
|
# Delete Managed User
|
|
344
|
-
result = api_instance.
|
|
345
|
+
result = api_instance.delete_managed_user(id)
|
|
345
346
|
p result
|
|
346
347
|
rescue ApiSdkRb::ApiError => e
|
|
347
|
-
puts "Error when calling ManagedUsersApi->
|
|
348
|
+
puts "Error when calling ManagedUsersApi->delete_managed_user: #{e}"
|
|
348
349
|
end
|
|
349
350
|
```
|
|
350
351
|
|
|
351
|
-
#### Using the
|
|
352
|
+
#### Using the delete_managed_user_with_http_info variant
|
|
352
353
|
|
|
353
354
|
This returns an Array which contains the response data, status code and headers.
|
|
354
355
|
|
|
355
|
-
> <Array(<
|
|
356
|
+
> <Array(<ManagedUserRemovalResponse>, Integer, Hash)> delete_managed_user_with_http_info(id)
|
|
356
357
|
|
|
357
358
|
```ruby
|
|
358
359
|
begin
|
|
359
360
|
# Delete Managed User
|
|
360
|
-
data, status_code, headers = api_instance.
|
|
361
|
+
data, status_code, headers = api_instance.delete_managed_user_with_http_info(id)
|
|
361
362
|
p status_code # => 2xx
|
|
362
363
|
p headers # => { ... }
|
|
363
|
-
p data # => <
|
|
364
|
+
p data # => <ManagedUserRemovalResponse>
|
|
364
365
|
rescue ApiSdkRb::ApiError => e
|
|
365
|
-
puts "Error when calling ManagedUsersApi->
|
|
366
|
+
puts "Error when calling ManagedUsersApi->delete_managed_user_with_http_info: #{e}"
|
|
366
367
|
end
|
|
367
368
|
```
|
|
368
369
|
|
|
@@ -374,7 +375,7 @@ end
|
|
|
374
375
|
|
|
375
376
|
### Return type
|
|
376
377
|
|
|
377
|
-
[**
|
|
378
|
+
[**ManagedUserRemovalResponse**](ManagedUserRemovalResponse.md)
|
|
378
379
|
|
|
379
380
|
### Authorization
|
|
380
381
|
|
|
@@ -386,9 +387,9 @@ end
|
|
|
386
387
|
- **Accept**: application/json
|
|
387
388
|
|
|
388
389
|
|
|
389
|
-
##
|
|
390
|
+
## get_all_managed_users
|
|
390
391
|
|
|
391
|
-
> <GetAllManagedUsers200Response>
|
|
392
|
+
> <GetAllManagedUsers200Response> get_all_managed_users(opts)
|
|
392
393
|
|
|
393
394
|
Get Managed Users
|
|
394
395
|
|
|
@@ -414,28 +415,28 @@ opts = {
|
|
|
414
415
|
|
|
415
416
|
begin
|
|
416
417
|
# Get Managed Users
|
|
417
|
-
result = api_instance.
|
|
418
|
+
result = api_instance.get_all_managed_users(opts)
|
|
418
419
|
p result
|
|
419
420
|
rescue ApiSdkRb::ApiError => e
|
|
420
|
-
puts "Error when calling ManagedUsersApi->
|
|
421
|
+
puts "Error when calling ManagedUsersApi->get_all_managed_users: #{e}"
|
|
421
422
|
end
|
|
422
423
|
```
|
|
423
424
|
|
|
424
|
-
#### Using the
|
|
425
|
+
#### Using the get_all_managed_users_with_http_info variant
|
|
425
426
|
|
|
426
427
|
This returns an Array which contains the response data, status code and headers.
|
|
427
428
|
|
|
428
|
-
> <Array(<GetAllManagedUsers200Response>, Integer, Hash)>
|
|
429
|
+
> <Array(<GetAllManagedUsers200Response>, Integer, Hash)> get_all_managed_users_with_http_info(opts)
|
|
429
430
|
|
|
430
431
|
```ruby
|
|
431
432
|
begin
|
|
432
433
|
# Get Managed Users
|
|
433
|
-
data, status_code, headers = api_instance.
|
|
434
|
+
data, status_code, headers = api_instance.get_all_managed_users_with_http_info(opts)
|
|
434
435
|
p status_code # => 2xx
|
|
435
436
|
p headers # => { ... }
|
|
436
437
|
p data # => <GetAllManagedUsers200Response>
|
|
437
438
|
rescue ApiSdkRb::ApiError => e
|
|
438
|
-
puts "Error when calling ManagedUsersApi->
|
|
439
|
+
puts "Error when calling ManagedUsersApi->get_all_managed_users_with_http_info: #{e}"
|
|
439
440
|
end
|
|
440
441
|
```
|
|
441
442
|
|
|
@@ -461,9 +462,9 @@ end
|
|
|
461
462
|
- **Accept**: application/json
|
|
462
463
|
|
|
463
464
|
|
|
464
|
-
##
|
|
465
|
+
## get_managed_user_by_id
|
|
465
466
|
|
|
466
|
-
> <ManagedUserResponse>
|
|
467
|
+
> <ManagedUserResponse> get_managed_user_by_id(id)
|
|
467
468
|
|
|
468
469
|
Get Managed User By ID
|
|
469
470
|
|
|
@@ -485,28 +486,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the managed user to
|
|
|
485
486
|
|
|
486
487
|
begin
|
|
487
488
|
# Get Managed User By ID
|
|
488
|
-
result = api_instance.
|
|
489
|
+
result = api_instance.get_managed_user_by_id(id)
|
|
489
490
|
p result
|
|
490
491
|
rescue ApiSdkRb::ApiError => e
|
|
491
|
-
puts "Error when calling ManagedUsersApi->
|
|
492
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_by_id: #{e}"
|
|
492
493
|
end
|
|
493
494
|
```
|
|
494
495
|
|
|
495
|
-
#### Using the
|
|
496
|
+
#### Using the get_managed_user_by_id_with_http_info variant
|
|
496
497
|
|
|
497
498
|
This returns an Array which contains the response data, status code and headers.
|
|
498
499
|
|
|
499
|
-
> <Array(<ManagedUserResponse>, Integer, Hash)>
|
|
500
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> get_managed_user_by_id_with_http_info(id)
|
|
500
501
|
|
|
501
502
|
```ruby
|
|
502
503
|
begin
|
|
503
504
|
# Get Managed User By ID
|
|
504
|
-
data, status_code, headers = api_instance.
|
|
505
|
+
data, status_code, headers = api_instance.get_managed_user_by_id_with_http_info(id)
|
|
505
506
|
p status_code # => 2xx
|
|
506
507
|
p headers # => { ... }
|
|
507
508
|
p data # => <ManagedUserResponse>
|
|
508
509
|
rescue ApiSdkRb::ApiError => e
|
|
509
|
-
puts "Error when calling ManagedUsersApi->
|
|
510
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_by_id_with_http_info: #{e}"
|
|
510
511
|
end
|
|
511
512
|
```
|
|
512
513
|
|
|
@@ -530,9 +531,9 @@ end
|
|
|
530
531
|
- **Accept**: application/json
|
|
531
532
|
|
|
532
533
|
|
|
533
|
-
##
|
|
534
|
+
## get_managed_user_design_defaults
|
|
534
535
|
|
|
535
|
-
> <
|
|
536
|
+
> <DesignDefaultsResponse> get_managed_user_design_defaults(id)
|
|
536
537
|
|
|
537
538
|
Read design defaults for one managed user
|
|
538
539
|
|
|
@@ -552,28 +553,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
552
553
|
|
|
553
554
|
begin
|
|
554
555
|
# Read design defaults for one managed user
|
|
555
|
-
result = api_instance.
|
|
556
|
+
result = api_instance.get_managed_user_design_defaults(id)
|
|
556
557
|
p result
|
|
557
558
|
rescue ApiSdkRb::ApiError => e
|
|
558
|
-
puts "Error when calling ManagedUsersApi->
|
|
559
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_design_defaults: #{e}"
|
|
559
560
|
end
|
|
560
561
|
```
|
|
561
562
|
|
|
562
|
-
#### Using the
|
|
563
|
+
#### Using the get_managed_user_design_defaults_with_http_info variant
|
|
563
564
|
|
|
564
565
|
This returns an Array which contains the response data, status code and headers.
|
|
565
566
|
|
|
566
|
-
> <Array(<
|
|
567
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> get_managed_user_design_defaults_with_http_info(id)
|
|
567
568
|
|
|
568
569
|
```ruby
|
|
569
570
|
begin
|
|
570
571
|
# Read design defaults for one managed user
|
|
571
|
-
data, status_code, headers = api_instance.
|
|
572
|
+
data, status_code, headers = api_instance.get_managed_user_design_defaults_with_http_info(id)
|
|
572
573
|
p status_code # => 2xx
|
|
573
574
|
p headers # => { ... }
|
|
574
|
-
p data # => <
|
|
575
|
+
p data # => <DesignDefaultsResponse>
|
|
575
576
|
rescue ApiSdkRb::ApiError => e
|
|
576
|
-
puts "Error when calling ManagedUsersApi->
|
|
577
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_design_defaults_with_http_info: #{e}"
|
|
577
578
|
end
|
|
578
579
|
```
|
|
579
580
|
|
|
@@ -585,7 +586,7 @@ end
|
|
|
585
586
|
|
|
586
587
|
### Return type
|
|
587
588
|
|
|
588
|
-
[**
|
|
589
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
589
590
|
|
|
590
591
|
### Authorization
|
|
591
592
|
|
|
@@ -597,9 +598,9 @@ end
|
|
|
597
598
|
- **Accept**: application/json
|
|
598
599
|
|
|
599
600
|
|
|
600
|
-
##
|
|
601
|
+
## get_managed_user_limits
|
|
601
602
|
|
|
602
|
-
> <
|
|
603
|
+
> <ManagedUserLimitsResponse> get_managed_user_limits(id)
|
|
603
604
|
|
|
604
605
|
Read monthly credit cap and usage for one managed user
|
|
605
606
|
|
|
@@ -619,28 +620,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
619
620
|
|
|
620
621
|
begin
|
|
621
622
|
# Read monthly credit cap and usage for one managed user
|
|
622
|
-
result = api_instance.
|
|
623
|
+
result = api_instance.get_managed_user_limits(id)
|
|
623
624
|
p result
|
|
624
625
|
rescue ApiSdkRb::ApiError => e
|
|
625
|
-
puts "Error when calling ManagedUsersApi->
|
|
626
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_limits: #{e}"
|
|
626
627
|
end
|
|
627
628
|
```
|
|
628
629
|
|
|
629
|
-
#### Using the
|
|
630
|
+
#### Using the get_managed_user_limits_with_http_info variant
|
|
630
631
|
|
|
631
632
|
This returns an Array which contains the response data, status code and headers.
|
|
632
633
|
|
|
633
|
-
> <Array(<
|
|
634
|
+
> <Array(<ManagedUserLimitsResponse>, Integer, Hash)> get_managed_user_limits_with_http_info(id)
|
|
634
635
|
|
|
635
636
|
```ruby
|
|
636
637
|
begin
|
|
637
638
|
# Read monthly credit cap and usage for one managed user
|
|
638
|
-
data, status_code, headers = api_instance.
|
|
639
|
+
data, status_code, headers = api_instance.get_managed_user_limits_with_http_info(id)
|
|
639
640
|
p status_code # => 2xx
|
|
640
641
|
p headers # => { ... }
|
|
641
|
-
p data # => <
|
|
642
|
+
p data # => <ManagedUserLimitsResponse>
|
|
642
643
|
rescue ApiSdkRb::ApiError => e
|
|
643
|
-
puts "Error when calling ManagedUsersApi->
|
|
644
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_limits_with_http_info: #{e}"
|
|
644
645
|
end
|
|
645
646
|
```
|
|
646
647
|
|
|
@@ -652,7 +653,7 @@ end
|
|
|
652
653
|
|
|
653
654
|
### Return type
|
|
654
655
|
|
|
655
|
-
[**
|
|
656
|
+
[**ManagedUserLimitsResponse**](ManagedUserLimitsResponse.md)
|
|
656
657
|
|
|
657
658
|
### Authorization
|
|
658
659
|
|
|
@@ -664,9 +665,9 @@ end
|
|
|
664
665
|
- **Accept**: application/json
|
|
665
666
|
|
|
666
667
|
|
|
667
|
-
##
|
|
668
|
+
## get_managed_user_storage_usage
|
|
668
669
|
|
|
669
|
-
> <GetManagedUserStorageUsage200Response>
|
|
670
|
+
> <GetManagedUserStorageUsage200Response> get_managed_user_storage_usage(id)
|
|
670
671
|
|
|
671
672
|
Storage used by one managed user's uploads
|
|
672
673
|
|
|
@@ -686,28 +687,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
686
687
|
|
|
687
688
|
begin
|
|
688
689
|
# Storage used by one managed user's uploads
|
|
689
|
-
result = api_instance.
|
|
690
|
+
result = api_instance.get_managed_user_storage_usage(id)
|
|
690
691
|
p result
|
|
691
692
|
rescue ApiSdkRb::ApiError => e
|
|
692
|
-
puts "Error when calling ManagedUsersApi->
|
|
693
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_storage_usage: #{e}"
|
|
693
694
|
end
|
|
694
695
|
```
|
|
695
696
|
|
|
696
|
-
#### Using the
|
|
697
|
+
#### Using the get_managed_user_storage_usage_with_http_info variant
|
|
697
698
|
|
|
698
699
|
This returns an Array which contains the response data, status code and headers.
|
|
699
700
|
|
|
700
|
-
> <Array(<GetManagedUserStorageUsage200Response>, Integer, Hash)>
|
|
701
|
+
> <Array(<GetManagedUserStorageUsage200Response>, Integer, Hash)> get_managed_user_storage_usage_with_http_info(id)
|
|
701
702
|
|
|
702
703
|
```ruby
|
|
703
704
|
begin
|
|
704
705
|
# Storage used by one managed user's uploads
|
|
705
|
-
data, status_code, headers = api_instance.
|
|
706
|
+
data, status_code, headers = api_instance.get_managed_user_storage_usage_with_http_info(id)
|
|
706
707
|
p status_code # => 2xx
|
|
707
708
|
p headers # => { ... }
|
|
708
709
|
p data # => <GetManagedUserStorageUsage200Response>
|
|
709
710
|
rescue ApiSdkRb::ApiError => e
|
|
710
|
-
puts "Error when calling ManagedUsersApi->
|
|
711
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_storage_usage_with_http_info: #{e}"
|
|
711
712
|
end
|
|
712
713
|
```
|
|
713
714
|
|
|
@@ -731,9 +732,9 @@ end
|
|
|
731
732
|
- **Accept**: application/json
|
|
732
733
|
|
|
733
734
|
|
|
734
|
-
##
|
|
735
|
+
## get_managed_user_usage
|
|
735
736
|
|
|
736
|
-
> <ManagedUserUsageResponse>
|
|
737
|
+
> <ManagedUserUsageResponse> get_managed_user_usage(id, opts)
|
|
737
738
|
|
|
738
739
|
What a managed user's editor sessions spent
|
|
739
740
|
|
|
@@ -759,28 +760,28 @@ opts = {
|
|
|
759
760
|
|
|
760
761
|
begin
|
|
761
762
|
# What a managed user's editor sessions spent
|
|
762
|
-
result = api_instance.
|
|
763
|
+
result = api_instance.get_managed_user_usage(id, opts)
|
|
763
764
|
p result
|
|
764
765
|
rescue ApiSdkRb::ApiError => e
|
|
765
|
-
puts "Error when calling ManagedUsersApi->
|
|
766
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_usage: #{e}"
|
|
766
767
|
end
|
|
767
768
|
```
|
|
768
769
|
|
|
769
|
-
#### Using the
|
|
770
|
+
#### Using the get_managed_user_usage_with_http_info variant
|
|
770
771
|
|
|
771
772
|
This returns an Array which contains the response data, status code and headers.
|
|
772
773
|
|
|
773
|
-
> <Array(<ManagedUserUsageResponse>, Integer, Hash)>
|
|
774
|
+
> <Array(<ManagedUserUsageResponse>, Integer, Hash)> get_managed_user_usage_with_http_info(id, opts)
|
|
774
775
|
|
|
775
776
|
```ruby
|
|
776
777
|
begin
|
|
777
778
|
# What a managed user's editor sessions spent
|
|
778
|
-
data, status_code, headers = api_instance.
|
|
779
|
+
data, status_code, headers = api_instance.get_managed_user_usage_with_http_info(id, opts)
|
|
779
780
|
p status_code # => 2xx
|
|
780
781
|
p headers # => { ... }
|
|
781
782
|
p data # => <ManagedUserUsageResponse>
|
|
782
783
|
rescue ApiSdkRb::ApiError => e
|
|
783
|
-
puts "Error when calling ManagedUsersApi->
|
|
784
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_usage_with_http_info: #{e}"
|
|
784
785
|
end
|
|
785
786
|
```
|
|
786
787
|
|
|
@@ -806,9 +807,9 @@ end
|
|
|
806
807
|
- **Accept**: application/json
|
|
807
808
|
|
|
808
809
|
|
|
809
|
-
##
|
|
810
|
+
## get_managed_users_by_manager_id
|
|
810
811
|
|
|
811
|
-
> <GetManagedUsersByManagerIdResponse>
|
|
812
|
+
> <GetManagedUsersByManagerIdResponse> get_managed_users_by_manager_id(manager_id, opts)
|
|
812
813
|
|
|
813
814
|
Get Managed Users By Manager
|
|
814
815
|
|
|
@@ -835,28 +836,28 @@ opts = {
|
|
|
835
836
|
|
|
836
837
|
begin
|
|
837
838
|
# Get Managed Users By Manager
|
|
838
|
-
result = api_instance.
|
|
839
|
+
result = api_instance.get_managed_users_by_manager_id(manager_id, opts)
|
|
839
840
|
p result
|
|
840
841
|
rescue ApiSdkRb::ApiError => e
|
|
841
|
-
puts "Error when calling ManagedUsersApi->
|
|
842
|
+
puts "Error when calling ManagedUsersApi->get_managed_users_by_manager_id: #{e}"
|
|
842
843
|
end
|
|
843
844
|
```
|
|
844
845
|
|
|
845
|
-
#### Using the
|
|
846
|
+
#### Using the get_managed_users_by_manager_id_with_http_info variant
|
|
846
847
|
|
|
847
848
|
This returns an Array which contains the response data, status code and headers.
|
|
848
849
|
|
|
849
|
-
> <Array(<GetManagedUsersByManagerIdResponse>, Integer, Hash)>
|
|
850
|
+
> <Array(<GetManagedUsersByManagerIdResponse>, Integer, Hash)> get_managed_users_by_manager_id_with_http_info(manager_id, opts)
|
|
850
851
|
|
|
851
852
|
```ruby
|
|
852
853
|
begin
|
|
853
854
|
# Get Managed Users By Manager
|
|
854
|
-
data, status_code, headers = api_instance.
|
|
855
|
+
data, status_code, headers = api_instance.get_managed_users_by_manager_id_with_http_info(manager_id, opts)
|
|
855
856
|
p status_code # => 2xx
|
|
856
857
|
p headers # => { ... }
|
|
857
858
|
p data # => <GetManagedUsersByManagerIdResponse>
|
|
858
859
|
rescue ApiSdkRb::ApiError => e
|
|
859
|
-
puts "Error when calling ManagedUsersApi->
|
|
860
|
+
puts "Error when calling ManagedUsersApi->get_managed_users_by_manager_id_with_http_info: #{e}"
|
|
860
861
|
end
|
|
861
862
|
```
|
|
862
863
|
|
|
@@ -883,9 +884,98 @@ end
|
|
|
883
884
|
- **Accept**: application/json
|
|
884
885
|
|
|
885
886
|
|
|
886
|
-
##
|
|
887
|
+
## list_managed_user_entries
|
|
887
888
|
|
|
888
|
-
> <
|
|
889
|
+
> <ManagedUserEntriesPageSuccess> list_managed_user_entries(id, opts)
|
|
890
|
+
|
|
891
|
+
List entries across a managed user's compositions
|
|
892
|
+
|
|
893
|
+
Merges eligible tables (time and id columns) across the managed user's compositions in global time order, then compositionId, table, and id (byte order). Only tables with both a time and an id column take part. Rate limit 30 requests per minute.
|
|
894
|
+
|
|
895
|
+
### Examples
|
|
896
|
+
|
|
897
|
+
```ruby
|
|
898
|
+
require 'time'
|
|
899
|
+
require 'api-sdk-rb'
|
|
900
|
+
# setup authorization
|
|
901
|
+
ApiSdkRb.configure do |config|
|
|
902
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
903
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
904
|
+
end
|
|
905
|
+
|
|
906
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
907
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
908
|
+
opts = {
|
|
909
|
+
composition_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String |
|
|
910
|
+
table: 'table_example', # String |
|
|
911
|
+
limit: 56, # Integer |
|
|
912
|
+
order: 'asc', # String | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id.
|
|
913
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`.
|
|
914
|
+
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
915
|
+
cursor: 'cursor_example', # String |
|
|
916
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
917
|
+
filter: { key: { key: 'inner_example'}} # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
begin
|
|
921
|
+
# List entries across a managed user's compositions
|
|
922
|
+
result = api_instance.list_managed_user_entries(id, opts)
|
|
923
|
+
p result
|
|
924
|
+
rescue ApiSdkRb::ApiError => e
|
|
925
|
+
puts "Error when calling ManagedUsersApi->list_managed_user_entries: #{e}"
|
|
926
|
+
end
|
|
927
|
+
```
|
|
928
|
+
|
|
929
|
+
#### Using the list_managed_user_entries_with_http_info variant
|
|
930
|
+
|
|
931
|
+
This returns an Array which contains the response data, status code and headers.
|
|
932
|
+
|
|
933
|
+
> <Array(<ManagedUserEntriesPageSuccess>, Integer, Hash)> list_managed_user_entries_with_http_info(id, opts)
|
|
934
|
+
|
|
935
|
+
```ruby
|
|
936
|
+
begin
|
|
937
|
+
# List entries across a managed user's compositions
|
|
938
|
+
data, status_code, headers = api_instance.list_managed_user_entries_with_http_info(id, opts)
|
|
939
|
+
p status_code # => 2xx
|
|
940
|
+
p headers # => { ... }
|
|
941
|
+
p data # => <ManagedUserEntriesPageSuccess>
|
|
942
|
+
rescue ApiSdkRb::ApiError => e
|
|
943
|
+
puts "Error when calling ManagedUsersApi->list_managed_user_entries_with_http_info: #{e}"
|
|
944
|
+
end
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
### Parameters
|
|
948
|
+
|
|
949
|
+
| Name | Type | Description | Notes |
|
|
950
|
+
| ---- | ---- | ----------- | ----- |
|
|
951
|
+
| **id** | **String** | | |
|
|
952
|
+
| **composition_id** | **String** | | [optional] |
|
|
953
|
+
| **table** | **String** | | [optional] |
|
|
954
|
+
| **limit** | **Integer** | | [optional][default to 25] |
|
|
955
|
+
| **order** | **String** | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id. | [optional][default to 'desc'] |
|
|
956
|
+
| **since** | **Time** | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`. | [optional] |
|
|
957
|
+
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
958
|
+
| **cursor** | **String** | | [optional] |
|
|
959
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
960
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
961
|
+
|
|
962
|
+
### Return type
|
|
963
|
+
|
|
964
|
+
[**ManagedUserEntriesPageSuccess**](ManagedUserEntriesPageSuccess.md)
|
|
965
|
+
|
|
966
|
+
### Authorization
|
|
967
|
+
|
|
968
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
969
|
+
|
|
970
|
+
### HTTP request headers
|
|
971
|
+
|
|
972
|
+
- **Content-Type**: Not defined
|
|
973
|
+
- **Accept**: application/json
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
## revoke_managed_user_editor_session
|
|
977
|
+
|
|
978
|
+
> <ManagedUserRemovalResponse> revoke_managed_user_editor_session(id, session_id)
|
|
889
979
|
|
|
890
980
|
End one editor session of a managed user
|
|
891
981
|
|
|
@@ -908,28 +998,28 @@ session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `sessionId` o
|
|
|
908
998
|
|
|
909
999
|
begin
|
|
910
1000
|
# End one editor session of a managed user
|
|
911
|
-
result = api_instance.
|
|
1001
|
+
result = api_instance.revoke_managed_user_editor_session(id, session_id)
|
|
912
1002
|
p result
|
|
913
1003
|
rescue ApiSdkRb::ApiError => e
|
|
914
|
-
puts "Error when calling ManagedUsersApi->
|
|
1004
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_session: #{e}"
|
|
915
1005
|
end
|
|
916
1006
|
```
|
|
917
1007
|
|
|
918
|
-
#### Using the
|
|
1008
|
+
#### Using the revoke_managed_user_editor_session_with_http_info variant
|
|
919
1009
|
|
|
920
1010
|
This returns an Array which contains the response data, status code and headers.
|
|
921
1011
|
|
|
922
|
-
> <Array(<
|
|
1012
|
+
> <Array(<ManagedUserRemovalResponse>, Integer, Hash)> revoke_managed_user_editor_session_with_http_info(id, session_id)
|
|
923
1013
|
|
|
924
1014
|
```ruby
|
|
925
1015
|
begin
|
|
926
1016
|
# End one editor session of a managed user
|
|
927
|
-
data, status_code, headers = api_instance.
|
|
1017
|
+
data, status_code, headers = api_instance.revoke_managed_user_editor_session_with_http_info(id, session_id)
|
|
928
1018
|
p status_code # => 2xx
|
|
929
1019
|
p headers # => { ... }
|
|
930
|
-
p data # => <
|
|
1020
|
+
p data # => <ManagedUserRemovalResponse>
|
|
931
1021
|
rescue ApiSdkRb::ApiError => e
|
|
932
|
-
puts "Error when calling ManagedUsersApi->
|
|
1022
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_session_with_http_info: #{e}"
|
|
933
1023
|
end
|
|
934
1024
|
```
|
|
935
1025
|
|
|
@@ -942,7 +1032,7 @@ end
|
|
|
942
1032
|
|
|
943
1033
|
### Return type
|
|
944
1034
|
|
|
945
|
-
[**
|
|
1035
|
+
[**ManagedUserRemovalResponse**](ManagedUserRemovalResponse.md)
|
|
946
1036
|
|
|
947
1037
|
### Authorization
|
|
948
1038
|
|
|
@@ -954,9 +1044,9 @@ end
|
|
|
954
1044
|
- **Accept**: application/json
|
|
955
1045
|
|
|
956
1046
|
|
|
957
|
-
##
|
|
1047
|
+
## revoke_managed_user_editor_sessions
|
|
958
1048
|
|
|
959
|
-
> <RevokeManagedUserEditorSessionsResponse>
|
|
1049
|
+
> <RevokeManagedUserEditorSessionsResponse> revoke_managed_user_editor_sessions(id)
|
|
960
1050
|
|
|
961
1051
|
End every editor session of a managed user
|
|
962
1052
|
|
|
@@ -978,28 +1068,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user whose se
|
|
|
978
1068
|
|
|
979
1069
|
begin
|
|
980
1070
|
# End every editor session of a managed user
|
|
981
|
-
result = api_instance.
|
|
1071
|
+
result = api_instance.revoke_managed_user_editor_sessions(id)
|
|
982
1072
|
p result
|
|
983
1073
|
rescue ApiSdkRb::ApiError => e
|
|
984
|
-
puts "Error when calling ManagedUsersApi->
|
|
1074
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_sessions: #{e}"
|
|
985
1075
|
end
|
|
986
1076
|
```
|
|
987
1077
|
|
|
988
|
-
#### Using the
|
|
1078
|
+
#### Using the revoke_managed_user_editor_sessions_with_http_info variant
|
|
989
1079
|
|
|
990
1080
|
This returns an Array which contains the response data, status code and headers.
|
|
991
1081
|
|
|
992
|
-
> <Array(<RevokeManagedUserEditorSessionsResponse>, Integer, Hash)>
|
|
1082
|
+
> <Array(<RevokeManagedUserEditorSessionsResponse>, Integer, Hash)> revoke_managed_user_editor_sessions_with_http_info(id)
|
|
993
1083
|
|
|
994
1084
|
```ruby
|
|
995
1085
|
begin
|
|
996
1086
|
# End every editor session of a managed user
|
|
997
|
-
data, status_code, headers = api_instance.
|
|
1087
|
+
data, status_code, headers = api_instance.revoke_managed_user_editor_sessions_with_http_info(id)
|
|
998
1088
|
p status_code # => 2xx
|
|
999
1089
|
p headers # => { ... }
|
|
1000
1090
|
p data # => <RevokeManagedUserEditorSessionsResponse>
|
|
1001
1091
|
rescue ApiSdkRb::ApiError => e
|
|
1002
|
-
puts "Error when calling ManagedUsersApi->
|
|
1092
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_sessions_with_http_info: #{e}"
|
|
1003
1093
|
end
|
|
1004
1094
|
```
|
|
1005
1095
|
|
|
@@ -1023,9 +1113,9 @@ end
|
|
|
1023
1113
|
- **Accept**: application/json
|
|
1024
1114
|
|
|
1025
1115
|
|
|
1026
|
-
##
|
|
1116
|
+
## set_managed_user_design_defaults
|
|
1027
1117
|
|
|
1028
|
-
> <
|
|
1118
|
+
> <DesignDefaultsResponse> set_managed_user_design_defaults(id, set_partner_design_defaults_request)
|
|
1029
1119
|
|
|
1030
1120
|
Set or clear design defaults for one managed user
|
|
1031
1121
|
|
|
@@ -1048,28 +1138,28 @@ set_partner_design_defaults_request = ApiSdkRb::SetPartnerDesignDefaultsRequest.
|
|
|
1048
1138
|
|
|
1049
1139
|
begin
|
|
1050
1140
|
# Set or clear design defaults for one managed user
|
|
1051
|
-
result = api_instance.
|
|
1141
|
+
result = api_instance.set_managed_user_design_defaults(id, set_partner_design_defaults_request)
|
|
1052
1142
|
p result
|
|
1053
1143
|
rescue ApiSdkRb::ApiError => e
|
|
1054
|
-
puts "Error when calling ManagedUsersApi->
|
|
1144
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_design_defaults: #{e}"
|
|
1055
1145
|
end
|
|
1056
1146
|
```
|
|
1057
1147
|
|
|
1058
|
-
#### Using the
|
|
1148
|
+
#### Using the set_managed_user_design_defaults_with_http_info variant
|
|
1059
1149
|
|
|
1060
1150
|
This returns an Array which contains the response data, status code and headers.
|
|
1061
1151
|
|
|
1062
|
-
> <Array(<
|
|
1152
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> set_managed_user_design_defaults_with_http_info(id, set_partner_design_defaults_request)
|
|
1063
1153
|
|
|
1064
1154
|
```ruby
|
|
1065
1155
|
begin
|
|
1066
1156
|
# Set or clear design defaults for one managed user
|
|
1067
|
-
data, status_code, headers = api_instance.
|
|
1157
|
+
data, status_code, headers = api_instance.set_managed_user_design_defaults_with_http_info(id, set_partner_design_defaults_request)
|
|
1068
1158
|
p status_code # => 2xx
|
|
1069
1159
|
p headers # => { ... }
|
|
1070
|
-
p data # => <
|
|
1160
|
+
p data # => <DesignDefaultsResponse>
|
|
1071
1161
|
rescue ApiSdkRb::ApiError => e
|
|
1072
|
-
puts "Error when calling ManagedUsersApi->
|
|
1162
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_design_defaults_with_http_info: #{e}"
|
|
1073
1163
|
end
|
|
1074
1164
|
```
|
|
1075
1165
|
|
|
@@ -1082,7 +1172,7 @@ end
|
|
|
1082
1172
|
|
|
1083
1173
|
### Return type
|
|
1084
1174
|
|
|
1085
|
-
[**
|
|
1175
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
1086
1176
|
|
|
1087
1177
|
### Authorization
|
|
1088
1178
|
|
|
@@ -1094,9 +1184,9 @@ end
|
|
|
1094
1184
|
- **Accept**: application/json
|
|
1095
1185
|
|
|
1096
1186
|
|
|
1097
|
-
##
|
|
1187
|
+
## set_managed_user_limits
|
|
1098
1188
|
|
|
1099
|
-
> <
|
|
1189
|
+
> <ManagedUserLimitsResponse> set_managed_user_limits(id, set_managed_user_limits_request)
|
|
1100
1190
|
|
|
1101
1191
|
Set or clear the monthly credit cap for one managed user
|
|
1102
1192
|
|
|
@@ -1119,28 +1209,28 @@ set_managed_user_limits_request = ApiSdkRb::SetManagedUserLimitsRequest.new({mon
|
|
|
1119
1209
|
|
|
1120
1210
|
begin
|
|
1121
1211
|
# Set or clear the monthly credit cap for one managed user
|
|
1122
|
-
result = api_instance.
|
|
1212
|
+
result = api_instance.set_managed_user_limits(id, set_managed_user_limits_request)
|
|
1123
1213
|
p result
|
|
1124
1214
|
rescue ApiSdkRb::ApiError => e
|
|
1125
|
-
puts "Error when calling ManagedUsersApi->
|
|
1215
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_limits: #{e}"
|
|
1126
1216
|
end
|
|
1127
1217
|
```
|
|
1128
1218
|
|
|
1129
|
-
#### Using the
|
|
1219
|
+
#### Using the set_managed_user_limits_with_http_info variant
|
|
1130
1220
|
|
|
1131
1221
|
This returns an Array which contains the response data, status code and headers.
|
|
1132
1222
|
|
|
1133
|
-
> <Array(<
|
|
1223
|
+
> <Array(<ManagedUserLimitsResponse>, Integer, Hash)> set_managed_user_limits_with_http_info(id, set_managed_user_limits_request)
|
|
1134
1224
|
|
|
1135
1225
|
```ruby
|
|
1136
1226
|
begin
|
|
1137
1227
|
# Set or clear the monthly credit cap for one managed user
|
|
1138
|
-
data, status_code, headers = api_instance.
|
|
1228
|
+
data, status_code, headers = api_instance.set_managed_user_limits_with_http_info(id, set_managed_user_limits_request)
|
|
1139
1229
|
p status_code # => 2xx
|
|
1140
1230
|
p headers # => { ... }
|
|
1141
|
-
p data # => <
|
|
1231
|
+
p data # => <ManagedUserLimitsResponse>
|
|
1142
1232
|
rescue ApiSdkRb::ApiError => e
|
|
1143
|
-
puts "Error when calling ManagedUsersApi->
|
|
1233
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_limits_with_http_info: #{e}"
|
|
1144
1234
|
end
|
|
1145
1235
|
```
|
|
1146
1236
|
|
|
@@ -1153,7 +1243,7 @@ end
|
|
|
1153
1243
|
|
|
1154
1244
|
### Return type
|
|
1155
1245
|
|
|
1156
|
-
[**
|
|
1246
|
+
[**ManagedUserLimitsResponse**](ManagedUserLimitsResponse.md)
|
|
1157
1247
|
|
|
1158
1248
|
### Authorization
|
|
1159
1249
|
|
|
@@ -1165,9 +1255,9 @@ end
|
|
|
1165
1255
|
- **Accept**: application/json
|
|
1166
1256
|
|
|
1167
1257
|
|
|
1168
|
-
##
|
|
1258
|
+
## update_managed_user
|
|
1169
1259
|
|
|
1170
|
-
> <ManagedUserResponse>
|
|
1260
|
+
> <ManagedUserResponse> update_managed_user(id, idempotency_key, update_managed_user)
|
|
1171
1261
|
|
|
1172
1262
|
Update Managed User
|
|
1173
1263
|
|
|
@@ -1191,28 +1281,28 @@ update_managed_user = ApiSdkRb::UpdateManagedUser.new # UpdateManagedUser |
|
|
|
1191
1281
|
|
|
1192
1282
|
begin
|
|
1193
1283
|
# Update Managed User
|
|
1194
|
-
result = api_instance.
|
|
1284
|
+
result = api_instance.update_managed_user(id, idempotency_key, update_managed_user)
|
|
1195
1285
|
p result
|
|
1196
1286
|
rescue ApiSdkRb::ApiError => e
|
|
1197
|
-
puts "Error when calling ManagedUsersApi->
|
|
1287
|
+
puts "Error when calling ManagedUsersApi->update_managed_user: #{e}"
|
|
1198
1288
|
end
|
|
1199
1289
|
```
|
|
1200
1290
|
|
|
1201
|
-
#### Using the
|
|
1291
|
+
#### Using the update_managed_user_with_http_info variant
|
|
1202
1292
|
|
|
1203
1293
|
This returns an Array which contains the response data, status code and headers.
|
|
1204
1294
|
|
|
1205
|
-
> <Array(<ManagedUserResponse>, Integer, Hash)>
|
|
1295
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> update_managed_user_with_http_info(id, idempotency_key, update_managed_user)
|
|
1206
1296
|
|
|
1207
1297
|
```ruby
|
|
1208
1298
|
begin
|
|
1209
1299
|
# Update Managed User
|
|
1210
|
-
data, status_code, headers = api_instance.
|
|
1300
|
+
data, status_code, headers = api_instance.update_managed_user_with_http_info(id, idempotency_key, update_managed_user)
|
|
1211
1301
|
p status_code # => 2xx
|
|
1212
1302
|
p headers # => { ... }
|
|
1213
1303
|
p data # => <ManagedUserResponse>
|
|
1214
1304
|
rescue ApiSdkRb::ApiError => e
|
|
1215
|
-
puts "Error when calling ManagedUsersApi->
|
|
1305
|
+
puts "Error when calling ManagedUsersApi->update_managed_user_with_http_info: #{e}"
|
|
1216
1306
|
end
|
|
1217
1307
|
```
|
|
1218
1308
|
|