api-sdk-rb 1.11.66 → 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 +294 -285
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/AdapterConnection.md +7 -1
- 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/BrandColor.md +22 -0
- data/docs/BrandFont.md +24 -0
- data/docs/BrandKitApi.md +593 -0
- data/docs/BrandKitAssetView.md +42 -0
- data/docs/BrandKitFigmaSource.md +26 -0
- data/docs/BrandKitTokens.md +26 -0
- data/docs/BrandKitTokensFonts.md +24 -0
- data/docs/BrandKitView.md +36 -0
- data/docs/BrandKitViewOwner.md +20 -0
- data/docs/{OperationsIdGetResponse.md → BrandKitViewResponse.md} +3 -3
- data/docs/BrandSpacing.md +32 -0
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/Composition.md +5 -1
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionLastEditedBy.md +20 -0
- data/docs/CompositionsApi.md +821 -473
- data/docs/ConfirmAdapterConnectionRequest.md +18 -0
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreateWidget201ResponseData.md +2 -4
- data/docs/CreateWorkspaceWorkflowFromPresetRequest.md +20 -0
- data/docs/CreateWorkspaceWorkflowRequest.md +22 -0
- data/docs/CreditsApi.md +20 -20
- data/docs/DeleteUpload200Response.md +22 -0
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/DeleteWorkspaceWorkflow200Response.md +22 -0
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/GetOperationResponse.md +22 -0
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/GetPublicCompositionEmbed200Response.md +7 -1
- data/docs/GetPublicCompositionEmbed200ResponseAdapters.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md +18 -0
- data/docs/GetPublicCompositionEmbed200ResponseEntries.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseMedia.md +18 -0
- data/docs/GetWorkspaceWorkflowStats200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowVersion200Response.md +22 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/ListPartnerWorkflowPresets200Response.md +22 -0
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/ListWorkspaceWorkflowCompositionOptions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowPresets200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowVersions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflows200Response.md +22 -0
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/NewComposition.md +1 -1
- data/docs/NewEditorSession.md +1 -1
- data/docs/OfferWorkflowPresetRequest.md +24 -0
- data/docs/OfferedWorkflowPreset.md +40 -0
- data/docs/OfferedWorkflowPresetList.md +18 -0
- data/docs/OfferedWorkflowPresetWidget.md +22 -0
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnerCustomization.md +2 -2
- data/docs/PartnerNotification.md +1 -1
- data/docs/PartnersApi.md +644 -352
- data/docs/PatchBrandKitAssetRequest.md +24 -0
- data/docs/PatchBrandKitRequest.md +30 -0
- data/docs/PatchBrandKitRequestFonts.md +24 -0
- data/docs/PatchBrandKitRequestSpacing.md +32 -0
- data/docs/PostBrandKitIconRequest.md +20 -0
- data/docs/PublicEmbedApi.md +324 -58
- data/docs/PublicWorkflow.md +36 -0
- data/docs/PublicWorkflowEventsAccepted.md +22 -0
- data/docs/PublicWorkflowEventsRequest.md +24 -0
- data/docs/PublicWorkflowEventsRequestEventsInner.md +24 -0
- data/docs/PublicWorkflowEventsRequestHeightsInner.md +20 -0
- data/docs/{CreateCompositionFromWidget201Response.md → PublicWorkflowResponse.md} +3 -3
- data/docs/PublicWorkflowTranslation.md +20 -0
- data/docs/PublishWorkspaceWorkflow200Response.md +22 -0
- data/docs/PublishWorkspaceWorkflowRequest.md +18 -0
- data/docs/PutBrandKitRequest.md +22 -0
- data/docs/RemovePartnerWorkflowPreset200Response.md +22 -0
- data/docs/ReportPublicWorkflowEvents200Response.md +22 -0
- data/docs/SaveWorkspaceWorkflowRequest.md +24 -0
- data/docs/SetAdapterConnectionRequest.md +1 -1
- data/docs/SetPartnerWorkflowPreset200Response.md +22 -0
- data/docs/TokensApi.md +11 -9
- data/docs/UpdateComposition.md +1 -1
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +191 -115
- data/docs/Widget.md +2 -4
- 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/Workflow.md +50 -0
- data/docs/WorkflowCompositionAction.md +24 -0
- data/docs/WorkflowCompositionField.md +24 -0
- data/docs/WorkflowCompositionOption.md +30 -0
- data/docs/WorkflowCompositionOptionActions.md +22 -0
- data/docs/WorkflowCompositionOptionInputs.md +24 -0
- data/docs/WorkflowCompositionOptions.md +24 -0
- data/docs/WorkflowConditionCase.md +24 -0
- data/docs/WorkflowConditionTest.md +22 -0
- data/docs/WorkflowCounter.md +20 -0
- data/docs/WorkflowDetail.md +60 -0
- data/docs/WorkflowDetailAllOfLastEditedBy.md +20 -0
- data/docs/WorkflowDetailResponse.md +22 -0
- data/docs/WorkflowEdge.md +24 -0
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/WorkflowFieldReference.md +22 -0
- data/docs/WorkflowGraph.md +22 -0
- data/docs/WorkflowIssue.md +28 -0
- data/docs/WorkflowList.md +24 -0
- data/docs/WorkflowNode.md +30 -0
- data/docs/WorkflowNodePosition.md +20 -0
- data/docs/WorkflowPresetChoice.md +26 -0
- data/docs/WorkflowPresetChoices.md +18 -0
- data/docs/WorkflowPresetRemoval.md +18 -0
- data/docs/WorkflowPresetWidget.md +20 -0
- data/docs/WorkflowPublishResult.md +22 -0
- data/docs/WorkflowRemoved.md +18 -0
- data/docs/WorkflowResponse.md +22 -0
- data/docs/WorkflowSchedule.md +24 -0
- data/docs/WorkflowStats.md +34 -0
- data/docs/WorkflowStatus.md +15 -0
- data/docs/WorkflowTrigger.md +28 -0
- data/docs/WorkflowTriggerValuesInner.md +20 -0
- data/docs/WorkflowVersion.md +28 -0
- data/docs/WorkflowVersionDetail.md +32 -0
- data/docs/WorkflowVersionList.md +18 -0
- data/docs/WorkflowVersionPublishedBy.md +20 -0
- data/docs/WorkflowsApi.md +1527 -0
- data/lib/api-sdk-rb/api/brand_kit_api.rb +581 -0
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +993 -565
- 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 +668 -352
- data/lib/api-sdk-rb/api/public_embed_api.rb +339 -62
- 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 +213 -119
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +1775 -0
- data/lib/api-sdk-rb/configuration.rb +11 -23
- 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/adapter_connection.rb +48 -5
- 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/adapter_connection_removal_response.rb +246 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → adapter_connection_response.rb} +4 -4
- data/lib/api-sdk-rb/models/ai_answers_knowledge_document_response.rb +246 -0
- data/lib/api-sdk-rb/models/brand_color.rb +329 -0
- data/lib/api-sdk-rb/models/brand_font.rb +357 -0
- data/lib/api-sdk-rb/models/brand_kit_asset_view.rb +409 -0
- data/lib/api-sdk-rb/models/brand_kit_figma_source.rb +277 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +335 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens_fonts.rb +241 -0
- data/lib/api-sdk-rb/models/brand_kit_view.rb +344 -0
- data/lib/api-sdk-rb/models/brand_kit_view_owner.rb +267 -0
- data/lib/api-sdk-rb/models/brand_kit_view_response.rb +247 -0
- data/lib/api-sdk-rb/models/brand_spacing.rb +557 -0
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/composition.rb +26 -5
- 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/composition_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/confirm_adapter_connection_request.rb +241 -0
- data/lib/api-sdk-rb/models/content_item_write_result_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_widget201_response_data.rb +9 -20
- data/lib/api-sdk-rb/models/create_workspace_workflow_from_preset_request.rb +278 -0
- data/lib/api-sdk-rb/models/create_workspace_workflow_request.rb +271 -0
- 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/delete_workspace_workflow200_response.rb +246 -0
- data/lib/api-sdk-rb/models/design_defaults_response.rb +246 -0
- 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/get_public_composition_embed200_response.rb +29 -2
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters.rb +225 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters_captcha.rb +216 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_entries.rb +224 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_media.rb +216 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_stats200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → get_workspace_workflow_version200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_partner_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/list_workspace_workflow_composition_options200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → list_workspace_workflow_presets200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → list_workspace_workflow_versions200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_workspace_workflows200_response.rb +246 -0
- 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/new_composition.rb +1 -1
- data/lib/api-sdk-rb/models/new_editor_session.rb +1 -1
- data/lib/api-sdk-rb/models/offer_workflow_preset_request.rb +322 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset.rb +423 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_list.rb +223 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_widget.rb +251 -0
- data/lib/api-sdk-rb/models/partner_notification.rb +1 -1
- data/lib/api-sdk-rb/models/partner_notification_event_type.rb +5 -1
- data/lib/api-sdk-rb/models/patch_brand_kit_asset_request.rb +289 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +363 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_fonts.rb +242 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_spacing.rb +502 -0
- data/lib/api-sdk-rb/models/post_brand_kit_icon_request.rb +237 -0
- data/lib/api-sdk-rb/models/public_workflow.rb +351 -0
- data/lib/api-sdk-rb/models/public_workflow_events_accepted.rb +242 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request.rb +301 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +354 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_heights_inner.rb +267 -0
- data/lib/api-sdk-rb/models/public_workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/public_workflow_translation.rb +242 -0
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → publish_workspace_workflow200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/publish_workspace_workflow_request.rb +240 -0
- data/lib/api-sdk-rb/models/put_brand_kit_request.rb +239 -0
- data/lib/api-sdk-rb/models/{remove_user_adapter_connection200_response.rb → remove_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/report_public_workflow_events200_response.rb +246 -0
- data/lib/api-sdk-rb/models/save_workspace_workflow_request.rb +296 -0
- data/lib/api-sdk-rb/models/set_adapter_connection_request.rb +1 -1
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → set_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/update_composition.rb +1 -1
- 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.rb +9 -20
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/widget_clarification_option.rb +256 -0
- 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/widget_plan_decisions_libraries_inner.rb +255 -0
- 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/workflow.rb +509 -0
- data/lib/api-sdk-rb/models/workflow_composition_action.rb +266 -0
- data/lib/api-sdk-rb/models/workflow_composition_field.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_composition_option.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_actions.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_inputs.rb +304 -0
- data/lib/api-sdk-rb/models/workflow_composition_options.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_condition_case.rb +322 -0
- data/lib/api-sdk-rb/models/workflow_condition_test.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_counter.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_detail.rb +580 -0
- data/lib/api-sdk-rb/models/workflow_detail_all_of_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/workflow_detail_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_edge.rb +292 -0
- 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_field_reference.rb +300 -0
- data/lib/api-sdk-rb/models/workflow_graph.rb +330 -0
- data/lib/api-sdk-rb/models/workflow_issue.rb +309 -0
- data/lib/api-sdk-rb/models/workflow_list.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_node.rb +343 -0
- data/lib/api-sdk-rb/models/workflow_node_position.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_preset_choice.rb +288 -0
- data/lib/api-sdk-rb/models/workflow_preset_choices.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_preset_removal.rb +222 -0
- data/lib/api-sdk-rb/models/workflow_preset_widget.rb +234 -0
- data/lib/api-sdk-rb/models/workflow_publish_result.rb +256 -0
- data/lib/api-sdk-rb/models/workflow_removed.rb +221 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_schedule.rb +298 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +347 -0
- data/lib/api-sdk-rb/models/workflow_status.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_trigger.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_trigger_values_inner.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_version.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_version_detail.rb +354 -0
- data/lib/api-sdk-rb/models/workflow_version_list.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_version_published_by.rb +225 -0
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +116 -17
- data/spec/api/brand_kit_api_spec.rb +136 -0
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +227 -149
- 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 +138 -84
- data/spec/api/public_embed_api_spec.rb +66 -15
- 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 +43 -28
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +339 -0
- data/spec/models/account_credit_transaction_list_response_spec.rb +48 -0
- data/spec/models/adapter_connection_list_response_spec.rb +48 -0
- data/spec/models/{get_managed_user_limits200_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/adapter_connection_spec.rb +18 -0
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_color_spec.rb +52 -0
- data/spec/models/brand_font_spec.rb +62 -0
- data/spec/models/brand_kit_asset_view_spec.rb +120 -0
- data/spec/models/brand_kit_figma_source_spec.rb +60 -0
- data/spec/models/brand_kit_tokens_fonts_spec.rb +54 -0
- data/spec/models/brand_kit_tokens_spec.rb +60 -0
- data/spec/models/brand_kit_view_owner_spec.rb +46 -0
- data/spec/models/{uploads_get200_response_spec.rb → brand_kit_view_response_spec.rb} +6 -6
- data/spec/models/brand_kit_view_spec.rb +90 -0
- data/spec/models/brand_spacing_spec.rb +78 -0
- data/spec/models/brand_text_style_spec.rb +52 -0
- data/spec/models/composition_database_record_response_spec.rb +48 -0
- data/spec/models/composition_last_edited_by_spec.rb +42 -0
- data/spec/models/composition_spec.rb +12 -0
- data/spec/models/confirm_adapter_connection_request_spec.rb +36 -0
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/create_widget201_response_data_spec.rb +1 -7
- data/spec/models/create_workspace_workflow_from_preset_request_spec.rb +42 -0
- data/spec/models/create_workspace_workflow_request_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/delete_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +1 -1
- 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/get_operation_response_spec.rb +48 -0
- data/spec/models/get_public_composition_embed200_response_adapters_captcha_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_adapters_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_entries_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_media_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_spec.rb +18 -0
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → get_workspace_workflow_stats200_response_spec.rb} +6 -6
- data/spec/models/{remove_user_adapter_connection200_response_spec.rb → get_workspace_workflow_version200_response_spec.rb} +6 -6
- data/spec/models/list_partner_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → list_workspace_workflow_composition_options200_response_spec.rb} +6 -6
- data/spec/models/{get_partner_credit_transactions200_response_spec.rb → list_workspace_workflow_presets200_response_spec.rb} +6 -6
- data/spec/models/{add_ai_answers_knowledge_document201_response_spec.rb → list_workspace_workflow_versions200_response_spec.rb} +6 -6
- data/spec/models/list_workspace_workflows200_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/new_editor_session_spec.rb +1 -1
- data/spec/models/offer_workflow_preset_request_spec.rb +54 -0
- data/spec/models/offered_workflow_preset_list_spec.rb +36 -0
- data/spec/models/offered_workflow_preset_spec.rb +106 -0
- data/spec/models/offered_workflow_preset_widget_spec.rb +48 -0
- data/spec/models/patch_brand_kit_asset_request_spec.rb +62 -0
- data/spec/models/patch_brand_kit_request_fonts_spec.rb +54 -0
- data/spec/models/patch_brand_kit_request_spacing_spec.rb +78 -0
- data/spec/models/patch_brand_kit_request_spec.rb +72 -0
- data/spec/models/post_brand_kit_icon_request_spec.rb +42 -0
- data/spec/models/public_workflow_events_accepted_spec.rb +48 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +62 -0
- data/spec/models/public_workflow_events_request_heights_inner_spec.rb +42 -0
- data/spec/models/public_workflow_events_request_spec.rb +54 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/public_workflow_spec.rb +94 -0
- data/spec/models/public_workflow_translation_spec.rb +42 -0
- data/spec/models/{get_partner_design_defaults200_response_spec.rb → publish_workspace_workflow200_response_spec.rb} +6 -6
- data/spec/models/publish_workspace_workflow_request_spec.rb +36 -0
- data/spec/models/put_brand_kit_request_spec.rb +48 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → remove_partner_workflow_preset200_response_spec.rb} +6 -6
- data/spec/models/report_public_workflow_events200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow_request_spec.rb +54 -0
- data/spec/models/{set_user_adapter_connection200_response_spec.rb → set_partner_workflow_preset200_response_spec.rb} +6 -6
- 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/widget_plan_spec.rb +60 -0
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/widget_spec.rb +1 -7
- data/spec/models/workflow_composition_action_spec.rb +54 -0
- data/spec/models/workflow_composition_field_spec.rb +58 -0
- data/spec/models/workflow_composition_option_actions_spec.rb +52 -0
- data/spec/models/workflow_composition_option_inputs_spec.rb +58 -0
- data/spec/models/workflow_composition_option_spec.rb +72 -0
- data/spec/models/workflow_composition_options_spec.rb +54 -0
- data/spec/models/workflow_condition_case_spec.rb +58 -0
- data/spec/models/workflow_condition_test_spec.rb +52 -0
- data/spec/models/workflow_counter_spec.rb +42 -0
- data/spec/models/workflow_detail_all_of_last_edited_by_spec.rb +42 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_detail_spec.rb +162 -0
- data/spec/models/workflow_edge_spec.rb +54 -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_field_reference_spec.rb +56 -0
- data/spec/models/workflow_graph_spec.rb +52 -0
- data/spec/models/workflow_issue_spec.rb +70 -0
- data/spec/models/{create_composition_content_item201_response_spec.rb → workflow_list_spec.rb} +15 -9
- data/spec/models/workflow_node_position_spec.rb +42 -0
- data/spec/models/workflow_node_spec.rb +76 -0
- data/spec/models/workflow_preset_choice_spec.rb +60 -0
- data/spec/models/workflow_preset_choices_spec.rb +36 -0
- data/spec/models/workflow_preset_removal_spec.rb +36 -0
- data/spec/models/workflow_preset_widget_spec.rb +42 -0
- data/spec/models/workflow_publish_result_spec.rb +48 -0
- data/spec/models/workflow_removed_spec.rb +36 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_schedule_spec.rb +62 -0
- data/spec/models/workflow_spec.rb +132 -0
- data/spec/models/workflow_stats_spec.rb +84 -0
- data/spec/models/workflow_status_spec.rb +30 -0
- data/spec/models/workflow_trigger_spec.rb +70 -0
- data/spec/models/workflow_trigger_values_inner_spec.rb +46 -0
- data/spec/models/workflow_version_detail_spec.rb +78 -0
- data/spec/models/workflow_version_list_spec.rb +36 -0
- data/spec/models/workflow_version_published_by_spec.rb +42 -0
- data/spec/models/workflow_version_spec.rb +66 -0
- metadata +476 -80
- data/docs/PartnerApi.md +0 -9892
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/lib/api-sdk-rb/api/partner_api.rb +0 -10693
- data/spec/api/partner_api_spec.rb +0 -1895
data/docs/UsersApi.md
CHANGED
|
@@ -4,23 +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
|
-
| [**
|
|
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 |
|
|
19
20
|
|
|
20
21
|
|
|
21
|
-
##
|
|
22
|
+
## add_personal_workspace_domain
|
|
22
23
|
|
|
23
|
-
> <PersonalWorkspaceDomainResultResponse>
|
|
24
|
+
> <PersonalWorkspaceDomainResultResponse> add_personal_workspace_domain(id, add_domain_request)
|
|
24
25
|
|
|
25
26
|
Allow a website to show your widgets
|
|
26
27
|
|
|
@@ -43,28 +44,28 @@ add_domain_request = ApiSdkRb::AddDomainRequest.new({domain: 'example.com'}) # A
|
|
|
43
44
|
|
|
44
45
|
begin
|
|
45
46
|
# Allow a website to show your widgets
|
|
46
|
-
result = api_instance.
|
|
47
|
+
result = api_instance.add_personal_workspace_domain(id, add_domain_request)
|
|
47
48
|
p result
|
|
48
49
|
rescue ApiSdkRb::ApiError => e
|
|
49
|
-
puts "Error when calling UsersApi->
|
|
50
|
+
puts "Error when calling UsersApi->add_personal_workspace_domain: #{e}"
|
|
50
51
|
end
|
|
51
52
|
```
|
|
52
53
|
|
|
53
|
-
#### Using the
|
|
54
|
+
#### Using the add_personal_workspace_domain_with_http_info variant
|
|
54
55
|
|
|
55
56
|
This returns an Array which contains the response data, status code and headers.
|
|
56
57
|
|
|
57
|
-
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)>
|
|
58
|
+
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> add_personal_workspace_domain_with_http_info(id, add_domain_request)
|
|
58
59
|
|
|
59
60
|
```ruby
|
|
60
61
|
begin
|
|
61
62
|
# Allow a website to show your widgets
|
|
62
|
-
data, status_code, headers = api_instance.
|
|
63
|
+
data, status_code, headers = api_instance.add_personal_workspace_domain_with_http_info(id, add_domain_request)
|
|
63
64
|
p status_code # => 2xx
|
|
64
65
|
p headers # => { ... }
|
|
65
66
|
p data # => <PersonalWorkspaceDomainResultResponse>
|
|
66
67
|
rescue ApiSdkRb::ApiError => e
|
|
67
|
-
puts "Error when calling UsersApi->
|
|
68
|
+
puts "Error when calling UsersApi->add_personal_workspace_domain_with_http_info: #{e}"
|
|
68
69
|
end
|
|
69
70
|
```
|
|
70
71
|
|
|
@@ -89,9 +90,84 @@ end
|
|
|
89
90
|
- **Accept**: application/json
|
|
90
91
|
|
|
91
92
|
|
|
92
|
-
##
|
|
93
|
+
## confirm_user_adapter_connection
|
|
93
94
|
|
|
94
|
-
> <
|
|
95
|
+
> <AdapterConnectionResponse> confirm_user_adapter_connection(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
96
|
+
|
|
97
|
+
Confirm an adapter address with the code that was emailed to it
|
|
98
|
+
|
|
99
|
+
Some credentials are an email address Widgetic sends a widget's messages to (`confirmation: email_code` in `getUserAdapterConnections`). Saving one with `setUserAdapterConnection` emails a six-digit code to it; this gives the code back. Only then is the address used: until it is confirmed, the widgets that need it are not charged and their visitors are told the feature is unavailable. The code works for 30 minutes and for five wrong tries. After that, save the address again and a new code is emailed (not sooner than a minute after the last one). A code that is not made of digits is refused without counting as a try. Confirming an address that is already confirmed answers 200 with the same state, so a retry of a request that went through is harmless. Saving a different address, or the same one before it was confirmed, starts again. This needs an API key with full access. The caller must be the account itself or a Widgetic administrator.
|
|
100
|
+
|
|
101
|
+
### Examples
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
require 'time'
|
|
105
|
+
require 'api-sdk-rb'
|
|
106
|
+
# setup authorization
|
|
107
|
+
ApiSdkRb.configure do |config|
|
|
108
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = ApiSdkRb::UsersApi.new
|
|
113
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account that keeps the address. For your own, your own user id
|
|
114
|
+
adapter_id = 'adapter_id_example' # String | The adapter the address is for
|
|
115
|
+
credential_key = 'credential_key_example' # String | The credential's name within the adapter
|
|
116
|
+
confirm_adapter_connection_request = ApiSdkRb::ConfirmAdapterConnectionRequest.new({code: '123456'}) # ConfirmAdapterConnectionRequest |
|
|
117
|
+
|
|
118
|
+
begin
|
|
119
|
+
# Confirm an adapter address with the code that was emailed to it
|
|
120
|
+
result = api_instance.confirm_user_adapter_connection(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
121
|
+
p result
|
|
122
|
+
rescue ApiSdkRb::ApiError => e
|
|
123
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
#### Using the confirm_user_adapter_connection_with_http_info variant
|
|
128
|
+
|
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
|
130
|
+
|
|
131
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> confirm_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
132
|
+
|
|
133
|
+
```ruby
|
|
134
|
+
begin
|
|
135
|
+
# Confirm an adapter address with the code that was emailed to it
|
|
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
|
+
p status_code # => 2xx
|
|
138
|
+
p headers # => { ... }
|
|
139
|
+
p data # => <AdapterConnectionResponse>
|
|
140
|
+
rescue ApiSdkRb::ApiError => e
|
|
141
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection_with_http_info: #{e}"
|
|
142
|
+
end
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
| Name | Type | Description | Notes |
|
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
|
149
|
+
| **user_id** | **String** | The account that keeps the address. For your own, your own user id | |
|
|
150
|
+
| **adapter_id** | **String** | The adapter the address is for | |
|
|
151
|
+
| **credential_key** | **String** | The credential's name within the adapter | |
|
|
152
|
+
| **confirm_adapter_connection_request** | [**ConfirmAdapterConnectionRequest**](ConfirmAdapterConnectionRequest.md) | | |
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
## create_user_api_key
|
|
169
|
+
|
|
170
|
+
> <CreatedUserApiKeyResponse> create_user_api_key(id, idempotency_key, create_user_api_key_request)
|
|
95
171
|
|
|
96
172
|
Create an API key
|
|
97
173
|
|
|
@@ -115,28 +191,28 @@ create_user_api_key_request = ApiSdkRb::CreateUserApiKeyRequest.new({name: 'Prod
|
|
|
115
191
|
|
|
116
192
|
begin
|
|
117
193
|
# Create an API key
|
|
118
|
-
result = api_instance.
|
|
194
|
+
result = api_instance.create_user_api_key(id, idempotency_key, create_user_api_key_request)
|
|
119
195
|
p result
|
|
120
196
|
rescue ApiSdkRb::ApiError => e
|
|
121
|
-
puts "Error when calling UsersApi->
|
|
197
|
+
puts "Error when calling UsersApi->create_user_api_key: #{e}"
|
|
122
198
|
end
|
|
123
199
|
```
|
|
124
200
|
|
|
125
|
-
#### Using the
|
|
201
|
+
#### Using the create_user_api_key_with_http_info variant
|
|
126
202
|
|
|
127
203
|
This returns an Array which contains the response data, status code and headers.
|
|
128
204
|
|
|
129
|
-
> <Array(<CreatedUserApiKeyResponse>, Integer, Hash)>
|
|
205
|
+
> <Array(<CreatedUserApiKeyResponse>, Integer, Hash)> create_user_api_key_with_http_info(id, idempotency_key, create_user_api_key_request)
|
|
130
206
|
|
|
131
207
|
```ruby
|
|
132
208
|
begin
|
|
133
209
|
# Create an API key
|
|
134
|
-
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)
|
|
135
211
|
p status_code # => 2xx
|
|
136
212
|
p headers # => { ... }
|
|
137
213
|
p data # => <CreatedUserApiKeyResponse>
|
|
138
214
|
rescue ApiSdkRb::ApiError => e
|
|
139
|
-
puts "Error when calling UsersApi->
|
|
215
|
+
puts "Error when calling UsersApi->create_user_api_key_with_http_info: #{e}"
|
|
140
216
|
end
|
|
141
217
|
```
|
|
142
218
|
|
|
@@ -162,9 +238,9 @@ end
|
|
|
162
238
|
- **Accept**: application/json
|
|
163
239
|
|
|
164
240
|
|
|
165
|
-
##
|
|
241
|
+
## delete_personal_workspace_domain
|
|
166
242
|
|
|
167
|
-
> <DeletePersonalWorkspaceDomainResponse>
|
|
243
|
+
> <DeletePersonalWorkspaceDomainResponse> delete_personal_workspace_domain(id, domain_id)
|
|
168
244
|
|
|
169
245
|
Stop allowing a website to show your widgets
|
|
170
246
|
|
|
@@ -187,28 +263,28 @@ domain_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `id` of the en
|
|
|
187
263
|
|
|
188
264
|
begin
|
|
189
265
|
# Stop allowing a website to show your widgets
|
|
190
|
-
result = api_instance.
|
|
266
|
+
result = api_instance.delete_personal_workspace_domain(id, domain_id)
|
|
191
267
|
p result
|
|
192
268
|
rescue ApiSdkRb::ApiError => e
|
|
193
|
-
puts "Error when calling UsersApi->
|
|
269
|
+
puts "Error when calling UsersApi->delete_personal_workspace_domain: #{e}"
|
|
194
270
|
end
|
|
195
271
|
```
|
|
196
272
|
|
|
197
|
-
#### Using the
|
|
273
|
+
#### Using the delete_personal_workspace_domain_with_http_info variant
|
|
198
274
|
|
|
199
275
|
This returns an Array which contains the response data, status code and headers.
|
|
200
276
|
|
|
201
|
-
> <Array(<DeletePersonalWorkspaceDomainResponse>, Integer, Hash)>
|
|
277
|
+
> <Array(<DeletePersonalWorkspaceDomainResponse>, Integer, Hash)> delete_personal_workspace_domain_with_http_info(id, domain_id)
|
|
202
278
|
|
|
203
279
|
```ruby
|
|
204
280
|
begin
|
|
205
281
|
# Stop allowing a website to show your widgets
|
|
206
|
-
data, status_code, headers = api_instance.
|
|
282
|
+
data, status_code, headers = api_instance.delete_personal_workspace_domain_with_http_info(id, domain_id)
|
|
207
283
|
p status_code # => 2xx
|
|
208
284
|
p headers # => { ... }
|
|
209
285
|
p data # => <DeletePersonalWorkspaceDomainResponse>
|
|
210
286
|
rescue ApiSdkRb::ApiError => e
|
|
211
|
-
puts "Error when calling UsersApi->
|
|
287
|
+
puts "Error when calling UsersApi->delete_personal_workspace_domain_with_http_info: #{e}"
|
|
212
288
|
end
|
|
213
289
|
```
|
|
214
290
|
|
|
@@ -233,9 +309,9 @@ end
|
|
|
233
309
|
- **Accept**: application/json
|
|
234
310
|
|
|
235
311
|
|
|
236
|
-
##
|
|
312
|
+
## delete_user_api_key
|
|
237
313
|
|
|
238
|
-
> <DeleteUserApiKeyResponse>
|
|
314
|
+
> <DeleteUserApiKeyResponse> delete_user_api_key(id, key_id)
|
|
239
315
|
|
|
240
316
|
Delete an API key
|
|
241
317
|
|
|
@@ -258,28 +334,28 @@ key_id = 'key_id_example' # String | The `keyId` of the key, as the list shows i
|
|
|
258
334
|
|
|
259
335
|
begin
|
|
260
336
|
# Delete an API key
|
|
261
|
-
result = api_instance.
|
|
337
|
+
result = api_instance.delete_user_api_key(id, key_id)
|
|
262
338
|
p result
|
|
263
339
|
rescue ApiSdkRb::ApiError => e
|
|
264
|
-
puts "Error when calling UsersApi->
|
|
340
|
+
puts "Error when calling UsersApi->delete_user_api_key: #{e}"
|
|
265
341
|
end
|
|
266
342
|
```
|
|
267
343
|
|
|
268
|
-
#### Using the
|
|
344
|
+
#### Using the delete_user_api_key_with_http_info variant
|
|
269
345
|
|
|
270
346
|
This returns an Array which contains the response data, status code and headers.
|
|
271
347
|
|
|
272
|
-
> <Array(<DeleteUserApiKeyResponse>, Integer, Hash)>
|
|
348
|
+
> <Array(<DeleteUserApiKeyResponse>, Integer, Hash)> delete_user_api_key_with_http_info(id, key_id)
|
|
273
349
|
|
|
274
350
|
```ruby
|
|
275
351
|
begin
|
|
276
352
|
# Delete an API key
|
|
277
|
-
data, status_code, headers = api_instance.
|
|
353
|
+
data, status_code, headers = api_instance.delete_user_api_key_with_http_info(id, key_id)
|
|
278
354
|
p status_code # => 2xx
|
|
279
355
|
p headers # => { ... }
|
|
280
356
|
p data # => <DeleteUserApiKeyResponse>
|
|
281
357
|
rescue ApiSdkRb::ApiError => e
|
|
282
|
-
puts "Error when calling UsersApi->
|
|
358
|
+
puts "Error when calling UsersApi->delete_user_api_key_with_http_info: #{e}"
|
|
283
359
|
end
|
|
284
360
|
```
|
|
285
361
|
|
|
@@ -304,9 +380,9 @@ end
|
|
|
304
380
|
- **Accept**: application/json
|
|
305
381
|
|
|
306
382
|
|
|
307
|
-
##
|
|
383
|
+
## get_personal_workspace_domains
|
|
308
384
|
|
|
309
|
-
> <GetPersonalWorkspaceDomains200Response>
|
|
385
|
+
> <GetPersonalWorkspaceDomains200Response> get_personal_workspace_domains(id)
|
|
310
386
|
|
|
311
387
|
List the websites allowed to show your widgets
|
|
312
388
|
|
|
@@ -328,28 +404,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the list belo
|
|
|
328
404
|
|
|
329
405
|
begin
|
|
330
406
|
# List the websites allowed to show your widgets
|
|
331
|
-
result = api_instance.
|
|
407
|
+
result = api_instance.get_personal_workspace_domains(id)
|
|
332
408
|
p result
|
|
333
409
|
rescue ApiSdkRb::ApiError => e
|
|
334
|
-
puts "Error when calling UsersApi->
|
|
410
|
+
puts "Error when calling UsersApi->get_personal_workspace_domains: #{e}"
|
|
335
411
|
end
|
|
336
412
|
```
|
|
337
413
|
|
|
338
|
-
#### Using the
|
|
414
|
+
#### Using the get_personal_workspace_domains_with_http_info variant
|
|
339
415
|
|
|
340
416
|
This returns an Array which contains the response data, status code and headers.
|
|
341
417
|
|
|
342
|
-
> <Array(<GetPersonalWorkspaceDomains200Response>, Integer, Hash)>
|
|
418
|
+
> <Array(<GetPersonalWorkspaceDomains200Response>, Integer, Hash)> get_personal_workspace_domains_with_http_info(id)
|
|
343
419
|
|
|
344
420
|
```ruby
|
|
345
421
|
begin
|
|
346
422
|
# List the websites allowed to show your widgets
|
|
347
|
-
data, status_code, headers = api_instance.
|
|
423
|
+
data, status_code, headers = api_instance.get_personal_workspace_domains_with_http_info(id)
|
|
348
424
|
p status_code # => 2xx
|
|
349
425
|
p headers # => { ... }
|
|
350
426
|
p data # => <GetPersonalWorkspaceDomains200Response>
|
|
351
427
|
rescue ApiSdkRb::ApiError => e
|
|
352
|
-
puts "Error when calling UsersApi->
|
|
428
|
+
puts "Error when calling UsersApi->get_personal_workspace_domains_with_http_info: #{e}"
|
|
353
429
|
end
|
|
354
430
|
```
|
|
355
431
|
|
|
@@ -373,9 +449,9 @@ end
|
|
|
373
449
|
- **Accept**: application/json
|
|
374
450
|
|
|
375
451
|
|
|
376
|
-
##
|
|
452
|
+
## get_user_adapter_connections
|
|
377
453
|
|
|
378
|
-
> <
|
|
454
|
+
> <AdapterConnectionListResponse> get_user_adapter_connections(user_id)
|
|
379
455
|
|
|
380
456
|
See which adapter keys an account has connected
|
|
381
457
|
|
|
@@ -397,28 +473,28 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account whose ad
|
|
|
397
473
|
|
|
398
474
|
begin
|
|
399
475
|
# See which adapter keys an account has connected
|
|
400
|
-
result = api_instance.
|
|
476
|
+
result = api_instance.get_user_adapter_connections(user_id)
|
|
401
477
|
p result
|
|
402
478
|
rescue ApiSdkRb::ApiError => e
|
|
403
|
-
puts "Error when calling UsersApi->
|
|
479
|
+
puts "Error when calling UsersApi->get_user_adapter_connections: #{e}"
|
|
404
480
|
end
|
|
405
481
|
```
|
|
406
482
|
|
|
407
|
-
#### Using the
|
|
483
|
+
#### Using the get_user_adapter_connections_with_http_info variant
|
|
408
484
|
|
|
409
485
|
This returns an Array which contains the response data, status code and headers.
|
|
410
486
|
|
|
411
|
-
> <Array(<
|
|
487
|
+
> <Array(<AdapterConnectionListResponse>, Integer, Hash)> get_user_adapter_connections_with_http_info(user_id)
|
|
412
488
|
|
|
413
489
|
```ruby
|
|
414
490
|
begin
|
|
415
491
|
# See which adapter keys an account has connected
|
|
416
|
-
data, status_code, headers = api_instance.
|
|
492
|
+
data, status_code, headers = api_instance.get_user_adapter_connections_with_http_info(user_id)
|
|
417
493
|
p status_code # => 2xx
|
|
418
494
|
p headers # => { ... }
|
|
419
|
-
p data # => <
|
|
495
|
+
p data # => <AdapterConnectionListResponse>
|
|
420
496
|
rescue ApiSdkRb::ApiError => e
|
|
421
|
-
puts "Error when calling UsersApi->
|
|
497
|
+
puts "Error when calling UsersApi->get_user_adapter_connections_with_http_info: #{e}"
|
|
422
498
|
end
|
|
423
499
|
```
|
|
424
500
|
|
|
@@ -430,7 +506,7 @@ end
|
|
|
430
506
|
|
|
431
507
|
### Return type
|
|
432
508
|
|
|
433
|
-
[**
|
|
509
|
+
[**AdapterConnectionListResponse**](AdapterConnectionListResponse.md)
|
|
434
510
|
|
|
435
511
|
### Authorization
|
|
436
512
|
|
|
@@ -442,9 +518,9 @@ end
|
|
|
442
518
|
- **Accept**: application/json
|
|
443
519
|
|
|
444
520
|
|
|
445
|
-
##
|
|
521
|
+
## get_user_api_key_usage_logs
|
|
446
522
|
|
|
447
|
-
> <GetUserApiKeyUsageLogsResponse>
|
|
523
|
+
> <GetUserApiKeyUsageLogsResponse> get_user_api_key_usage_logs(id, key_id, opts)
|
|
448
524
|
|
|
449
525
|
Read what an API key was used for
|
|
450
526
|
|
|
@@ -470,28 +546,28 @@ opts = {
|
|
|
470
546
|
|
|
471
547
|
begin
|
|
472
548
|
# Read what an API key was used for
|
|
473
|
-
result = api_instance.
|
|
549
|
+
result = api_instance.get_user_api_key_usage_logs(id, key_id, opts)
|
|
474
550
|
p result
|
|
475
551
|
rescue ApiSdkRb::ApiError => e
|
|
476
|
-
puts "Error when calling UsersApi->
|
|
552
|
+
puts "Error when calling UsersApi->get_user_api_key_usage_logs: #{e}"
|
|
477
553
|
end
|
|
478
554
|
```
|
|
479
555
|
|
|
480
|
-
#### Using the
|
|
556
|
+
#### Using the get_user_api_key_usage_logs_with_http_info variant
|
|
481
557
|
|
|
482
558
|
This returns an Array which contains the response data, status code and headers.
|
|
483
559
|
|
|
484
|
-
> <Array(<GetUserApiKeyUsageLogsResponse>, Integer, Hash)>
|
|
560
|
+
> <Array(<GetUserApiKeyUsageLogsResponse>, Integer, Hash)> get_user_api_key_usage_logs_with_http_info(id, key_id, opts)
|
|
485
561
|
|
|
486
562
|
```ruby
|
|
487
563
|
begin
|
|
488
564
|
# Read what an API key was used for
|
|
489
|
-
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)
|
|
490
566
|
p status_code # => 2xx
|
|
491
567
|
p headers # => { ... }
|
|
492
568
|
p data # => <GetUserApiKeyUsageLogsResponse>
|
|
493
569
|
rescue ApiSdkRb::ApiError => e
|
|
494
|
-
puts "Error when calling UsersApi->
|
|
570
|
+
puts "Error when calling UsersApi->get_user_api_key_usage_logs_with_http_info: #{e}"
|
|
495
571
|
end
|
|
496
572
|
```
|
|
497
573
|
|
|
@@ -517,9 +593,9 @@ end
|
|
|
517
593
|
- **Accept**: application/json
|
|
518
594
|
|
|
519
595
|
|
|
520
|
-
##
|
|
596
|
+
## get_user_api_keys
|
|
521
597
|
|
|
522
|
-
> <GetUserApiKeys200Response>
|
|
598
|
+
> <GetUserApiKeys200Response> get_user_api_keys(id)
|
|
523
599
|
|
|
524
600
|
List the API keys of an account
|
|
525
601
|
|
|
@@ -541,28 +617,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account the keys belo
|
|
|
541
617
|
|
|
542
618
|
begin
|
|
543
619
|
# List the API keys of an account
|
|
544
|
-
result = api_instance.
|
|
620
|
+
result = api_instance.get_user_api_keys(id)
|
|
545
621
|
p result
|
|
546
622
|
rescue ApiSdkRb::ApiError => e
|
|
547
|
-
puts "Error when calling UsersApi->
|
|
623
|
+
puts "Error when calling UsersApi->get_user_api_keys: #{e}"
|
|
548
624
|
end
|
|
549
625
|
```
|
|
550
626
|
|
|
551
|
-
#### Using the
|
|
627
|
+
#### Using the get_user_api_keys_with_http_info variant
|
|
552
628
|
|
|
553
629
|
This returns an Array which contains the response data, status code and headers.
|
|
554
630
|
|
|
555
|
-
> <Array(<GetUserApiKeys200Response>, Integer, Hash)>
|
|
631
|
+
> <Array(<GetUserApiKeys200Response>, Integer, Hash)> get_user_api_keys_with_http_info(id)
|
|
556
632
|
|
|
557
633
|
```ruby
|
|
558
634
|
begin
|
|
559
635
|
# List the API keys of an account
|
|
560
|
-
data, status_code, headers = api_instance.
|
|
636
|
+
data, status_code, headers = api_instance.get_user_api_keys_with_http_info(id)
|
|
561
637
|
p status_code # => 2xx
|
|
562
638
|
p headers # => { ... }
|
|
563
639
|
p data # => <GetUserApiKeys200Response>
|
|
564
640
|
rescue ApiSdkRb::ApiError => e
|
|
565
|
-
puts "Error when calling UsersApi->
|
|
641
|
+
puts "Error when calling UsersApi->get_user_api_keys_with_http_info: #{e}"
|
|
566
642
|
end
|
|
567
643
|
```
|
|
568
644
|
|
|
@@ -586,9 +662,9 @@ end
|
|
|
586
662
|
- **Accept**: application/json
|
|
587
663
|
|
|
588
664
|
|
|
589
|
-
##
|
|
665
|
+
## remove_user_adapter_connection
|
|
590
666
|
|
|
591
|
-
> <
|
|
667
|
+
> <AdapterConnectionRemovalResponse> remove_user_adapter_connection(user_id, adapter_id, credential_key)
|
|
592
668
|
|
|
593
669
|
Remove an adapter key from an account
|
|
594
670
|
|
|
@@ -612,28 +688,28 @@ credential_key = 'credential_key_example' # String | The key's name within the a
|
|
|
612
688
|
|
|
613
689
|
begin
|
|
614
690
|
# Remove an adapter key from an account
|
|
615
|
-
result = api_instance.
|
|
691
|
+
result = api_instance.remove_user_adapter_connection(user_id, adapter_id, credential_key)
|
|
616
692
|
p result
|
|
617
693
|
rescue ApiSdkRb::ApiError => e
|
|
618
|
-
puts "Error when calling UsersApi->
|
|
694
|
+
puts "Error when calling UsersApi->remove_user_adapter_connection: #{e}"
|
|
619
695
|
end
|
|
620
696
|
```
|
|
621
697
|
|
|
622
|
-
#### Using the
|
|
698
|
+
#### Using the remove_user_adapter_connection_with_http_info variant
|
|
623
699
|
|
|
624
700
|
This returns an Array which contains the response data, status code and headers.
|
|
625
701
|
|
|
626
|
-
> <Array(<
|
|
702
|
+
> <Array(<AdapterConnectionRemovalResponse>, Integer, Hash)> remove_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key)
|
|
627
703
|
|
|
628
704
|
```ruby
|
|
629
705
|
begin
|
|
630
706
|
# Remove an adapter key from an account
|
|
631
|
-
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)
|
|
632
708
|
p status_code # => 2xx
|
|
633
709
|
p headers # => { ... }
|
|
634
|
-
p data # => <
|
|
710
|
+
p data # => <AdapterConnectionRemovalResponse>
|
|
635
711
|
rescue ApiSdkRb::ApiError => e
|
|
636
|
-
puts "Error when calling UsersApi->
|
|
712
|
+
puts "Error when calling UsersApi->remove_user_adapter_connection_with_http_info: #{e}"
|
|
637
713
|
end
|
|
638
714
|
```
|
|
639
715
|
|
|
@@ -647,7 +723,7 @@ end
|
|
|
647
723
|
|
|
648
724
|
### Return type
|
|
649
725
|
|
|
650
|
-
[**
|
|
726
|
+
[**AdapterConnectionRemovalResponse**](AdapterConnectionRemovalResponse.md)
|
|
651
727
|
|
|
652
728
|
### Authorization
|
|
653
729
|
|
|
@@ -659,13 +735,13 @@ end
|
|
|
659
735
|
- **Accept**: application/json
|
|
660
736
|
|
|
661
737
|
|
|
662
|
-
##
|
|
738
|
+
## set_user_adapter_connection
|
|
663
739
|
|
|
664
|
-
> <
|
|
740
|
+
> <AdapterConnectionResponse> set_user_adapter_connection(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
665
741
|
|
|
666
742
|
Connect an adapter key to an account
|
|
667
743
|
|
|
668
|
-
Gives an adapter the key it needs to act through a service you have an account with, for the widgets you made. Take the `adapterId` and `credentialKey` from `getUserAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this account, this adapter and this credential, so that a stored value cannot be moved to another. It is never returned, never logged and never shown to a visitor of a widget. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on your behalf, and discards it. To cut that off, remove the key here, or revoke it with the provider. **What is checked.** That the adapter exists and takes this credential, that an owner may keep it (some are for a partner only) and that the text is one line of at most 2048 characters. Whether the provider accepts the key is not checked here: it shows the first time a widget uses it, and the widget tells its owner. A widget whose adapter has no key connected is not charged and does not run that adapter: its visitors are told the feature is unavailable, and the owner is told once a day what to
|
|
744
|
+
Gives an adapter the key it needs to act through a service you have an account with, for the widgets you made. Take the `adapterId` and `credentialKey` from `getUserAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this account, this adapter and this credential, so that a stored value cannot be moved to another. It is never returned, never logged and never shown to a visitor of a widget. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on your behalf, and discards it. To cut that off, remove the key here, or revoke it with the provider. **What is checked.** That the adapter exists and takes this credential, that an owner may keep it (some are for a partner only) and that the text is one line of at most 2048 characters. Whether the provider accepts the key is not checked here: it shows the first time a widget uses it, and the widget tells its owner. **An address that has to be confirmed.** Some credentials are not a key but the email address Widgetic sends a widget's messages to (`confirmation: email_code` in `getUserAdapterConnections`). Saving one checks that it is one email address and emails a six-digit code to it; the answer says `awaitingConfirmation: true`, and nothing is sent to the address until the code is given back with `confirmUserAdapterConnection`. Saving the same address again before it is confirmed emails a new code (not sooner than a minute after the last); saving the address that is already confirmed changes nothing. If the code cannot be emailed, nothing is saved. A widget whose adapter has no key connected, or whose address is not confirmed yet, is not charged and does not run that adapter: its visitors are told the feature is unavailable, and the owner is told once a day what to do. This needs an API key with full access. The caller must be the account itself or a Widgetic administrator. A retry is harmless: saving the same key twice only refreshes when it was set.
|
|
669
745
|
|
|
670
746
|
### Examples
|
|
671
747
|
|
|
@@ -686,28 +762,28 @@ set_adapter_connection_request = ApiSdkRb::SetAdapterConnectionRequest.new({cred
|
|
|
686
762
|
|
|
687
763
|
begin
|
|
688
764
|
# Connect an adapter key to an account
|
|
689
|
-
result = api_instance.
|
|
765
|
+
result = api_instance.set_user_adapter_connection(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
690
766
|
p result
|
|
691
767
|
rescue ApiSdkRb::ApiError => e
|
|
692
|
-
puts "Error when calling UsersApi->
|
|
768
|
+
puts "Error when calling UsersApi->set_user_adapter_connection: #{e}"
|
|
693
769
|
end
|
|
694
770
|
```
|
|
695
771
|
|
|
696
|
-
#### Using the
|
|
772
|
+
#### Using the set_user_adapter_connection_with_http_info variant
|
|
697
773
|
|
|
698
774
|
This returns an Array which contains the response data, status code and headers.
|
|
699
775
|
|
|
700
|
-
> <Array(<
|
|
776
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> set_user_adapter_connection_with_http_info(user_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
701
777
|
|
|
702
778
|
```ruby
|
|
703
779
|
begin
|
|
704
780
|
# Connect an adapter key to an account
|
|
705
|
-
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)
|
|
706
782
|
p status_code # => 2xx
|
|
707
783
|
p headers # => { ... }
|
|
708
|
-
p data # => <
|
|
784
|
+
p data # => <AdapterConnectionResponse>
|
|
709
785
|
rescue ApiSdkRb::ApiError => e
|
|
710
|
-
puts "Error when calling UsersApi->
|
|
786
|
+
puts "Error when calling UsersApi->set_user_adapter_connection_with_http_info: #{e}"
|
|
711
787
|
end
|
|
712
788
|
```
|
|
713
789
|
|
|
@@ -722,7 +798,7 @@ end
|
|
|
722
798
|
|
|
723
799
|
### Return type
|
|
724
800
|
|
|
725
|
-
[**
|
|
801
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
726
802
|
|
|
727
803
|
### Authorization
|
|
728
804
|
|
|
@@ -734,9 +810,9 @@ end
|
|
|
734
810
|
- **Accept**: application/json
|
|
735
811
|
|
|
736
812
|
|
|
737
|
-
##
|
|
813
|
+
## update_personal_workspace_domain
|
|
738
814
|
|
|
739
|
-
> <PersonalWorkspaceDomainResultResponse>
|
|
815
|
+
> <PersonalWorkspaceDomainResultResponse> update_personal_workspace_domain(id, domain_id, update_domain_request)
|
|
740
816
|
|
|
741
817
|
Change a website on your list
|
|
742
818
|
|
|
@@ -760,28 +836,28 @@ update_domain_request = ApiSdkRb::UpdateDomainRequest.new({domain: 'example.com'
|
|
|
760
836
|
|
|
761
837
|
begin
|
|
762
838
|
# Change a website on your list
|
|
763
|
-
result = api_instance.
|
|
839
|
+
result = api_instance.update_personal_workspace_domain(id, domain_id, update_domain_request)
|
|
764
840
|
p result
|
|
765
841
|
rescue ApiSdkRb::ApiError => e
|
|
766
|
-
puts "Error when calling UsersApi->
|
|
842
|
+
puts "Error when calling UsersApi->update_personal_workspace_domain: #{e}"
|
|
767
843
|
end
|
|
768
844
|
```
|
|
769
845
|
|
|
770
|
-
#### Using the
|
|
846
|
+
#### Using the update_personal_workspace_domain_with_http_info variant
|
|
771
847
|
|
|
772
848
|
This returns an Array which contains the response data, status code and headers.
|
|
773
849
|
|
|
774
|
-
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)>
|
|
850
|
+
> <Array(<PersonalWorkspaceDomainResultResponse>, Integer, Hash)> update_personal_workspace_domain_with_http_info(id, domain_id, update_domain_request)
|
|
775
851
|
|
|
776
852
|
```ruby
|
|
777
853
|
begin
|
|
778
854
|
# Change a website on your list
|
|
779
|
-
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)
|
|
780
856
|
p status_code # => 2xx
|
|
781
857
|
p headers # => { ... }
|
|
782
858
|
p data # => <PersonalWorkspaceDomainResultResponse>
|
|
783
859
|
rescue ApiSdkRb::ApiError => e
|
|
784
|
-
puts "Error when calling UsersApi->
|
|
860
|
+
puts "Error when calling UsersApi->update_personal_workspace_domain_with_http_info: #{e}"
|
|
785
861
|
end
|
|
786
862
|
```
|
|
787
863
|
|
|
@@ -807,9 +883,9 @@ end
|
|
|
807
883
|
- **Accept**: application/json
|
|
808
884
|
|
|
809
885
|
|
|
810
|
-
##
|
|
886
|
+
## update_user_api_key
|
|
811
887
|
|
|
812
|
-
> <UserApiKeyResponse>
|
|
888
|
+
> <UserApiKeyResponse> update_user_api_key(id, key_id, update_user_api_key_request)
|
|
813
889
|
|
|
814
890
|
Rename an API key, or switch it off or on
|
|
815
891
|
|
|
@@ -833,28 +909,28 @@ update_user_api_key_request = ApiSdkRb::UpdateUserApiKeyRequest.new # UpdateUser
|
|
|
833
909
|
|
|
834
910
|
begin
|
|
835
911
|
# Rename an API key, or switch it off or on
|
|
836
|
-
result = api_instance.
|
|
912
|
+
result = api_instance.update_user_api_key(id, key_id, update_user_api_key_request)
|
|
837
913
|
p result
|
|
838
914
|
rescue ApiSdkRb::ApiError => e
|
|
839
|
-
puts "Error when calling UsersApi->
|
|
915
|
+
puts "Error when calling UsersApi->update_user_api_key: #{e}"
|
|
840
916
|
end
|
|
841
917
|
```
|
|
842
918
|
|
|
843
|
-
#### Using the
|
|
919
|
+
#### Using the update_user_api_key_with_http_info variant
|
|
844
920
|
|
|
845
921
|
This returns an Array which contains the response data, status code and headers.
|
|
846
922
|
|
|
847
|
-
> <Array(<UserApiKeyResponse>, Integer, Hash)>
|
|
923
|
+
> <Array(<UserApiKeyResponse>, Integer, Hash)> update_user_api_key_with_http_info(id, key_id, update_user_api_key_request)
|
|
848
924
|
|
|
849
925
|
```ruby
|
|
850
926
|
begin
|
|
851
927
|
# Rename an API key, or switch it off or on
|
|
852
|
-
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)
|
|
853
929
|
p status_code # => 2xx
|
|
854
930
|
p headers # => { ... }
|
|
855
931
|
p data # => <UserApiKeyResponse>
|
|
856
932
|
rescue ApiSdkRb::ApiError => e
|
|
857
|
-
puts "Error when calling UsersApi->
|
|
933
|
+
puts "Error when calling UsersApi->update_user_api_key_with_http_info: #{e}"
|
|
858
934
|
end
|
|
859
935
|
```
|
|
860
936
|
|