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
|
@@ -20,19 +20,21 @@ module ApiSdkRb
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Validate current authentication token
|
|
23
|
+
# Describes the credential the request was made with: how it signs in (`tokenType`), what it may do (`scopes`) and the account it belongs to (`userId`). A credential that belongs to the platform itself, and not to a customer's account, is held to no scope: it is answered with `tokenType` `service_key`, `scopes` `[\"*:*\"]` and no `userId`.
|
|
23
24
|
# @param [Hash] opts the optional parameters
|
|
24
25
|
# @return [ValidateToken200Response]
|
|
25
|
-
def
|
|
26
|
-
data, _status_code, _headers =
|
|
26
|
+
def validate_token(opts = {})
|
|
27
|
+
data, _status_code, _headers = validate_token_with_http_info(opts)
|
|
27
28
|
data
|
|
28
29
|
end
|
|
29
30
|
|
|
30
31
|
# Validate current authentication token
|
|
32
|
+
# Describes the credential the request was made with: how it signs in (`tokenType`), what it may do (`scopes`) and the account it belongs to (`userId`). A credential that belongs to the platform itself, and not to a customer's account, is held to no scope: it is answered with `tokenType` `service_key`, `scopes` `[\"*:*\"]` and no `userId`.
|
|
31
33
|
# @param [Hash] opts the optional parameters
|
|
32
34
|
# @return [Array<(ValidateToken200Response, Integer, Hash)>] ValidateToken200Response data, response status code and response headers
|
|
33
|
-
def
|
|
35
|
+
def validate_token_with_http_info(opts = {})
|
|
34
36
|
if @api_client.config.debugging
|
|
35
|
-
@api_client.config.logger.debug 'Calling API: TokensApi.
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: TokensApi.validate_token ...'
|
|
36
38
|
end
|
|
37
39
|
# resource path
|
|
38
40
|
local_var_path = '/tokens/validate'
|
|
@@ -58,7 +60,7 @@ module ApiSdkRb
|
|
|
58
60
|
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
59
61
|
|
|
60
62
|
new_options = opts.merge(
|
|
61
|
-
:operation => :"TokensApi.
|
|
63
|
+
:operation => :"TokensApi.validate_token",
|
|
62
64
|
:header_params => header_params,
|
|
63
65
|
:query_params => query_params,
|
|
64
66
|
:form_params => form_params,
|
|
@@ -69,7 +71,7 @@ module ApiSdkRb
|
|
|
69
71
|
|
|
70
72
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
71
73
|
if @api_client.config.debugging
|
|
72
|
-
@api_client.config.logger.debug "API called: TokensApi#
|
|
74
|
+
@api_client.config.logger.debug "API called: TokensApi#validate_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
73
75
|
end
|
|
74
76
|
return data, status_code, headers
|
|
75
77
|
end
|
|
@@ -19,49 +19,34 @@ module ApiSdkRb
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
#
|
|
23
|
-
#
|
|
22
|
+
# Delete an upload
|
|
23
|
+
# Removes the stored file and the upload row. A file in Widgetic's own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated.
|
|
24
|
+
# @param id [String]
|
|
24
25
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
# @return [UploadsGet200Response]
|
|
29
|
-
def uploads_get_0(opts = {})
|
|
30
|
-
data, _status_code, _headers = uploads_get_0_with_http_info(opts)
|
|
26
|
+
# @return [DeleteUpload200Response]
|
|
27
|
+
def delete_upload(id, opts = {})
|
|
28
|
+
data, _status_code, _headers = delete_upload_with_http_info(id, opts)
|
|
31
29
|
data
|
|
32
30
|
end
|
|
33
31
|
|
|
34
|
-
#
|
|
35
|
-
#
|
|
32
|
+
# Delete an upload
|
|
33
|
+
# Removes the stored file and the upload row. A file in Widgetic's own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated.
|
|
34
|
+
# @param id [String]
|
|
36
35
|
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @
|
|
38
|
-
|
|
39
|
-
# @option opts [String] :managed_user_external_id List only the files uploaded for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
|
|
40
|
-
# @return [Array<(UploadsGet200Response, Integer, Hash)>] UploadsGet200Response data, response status code and response headers
|
|
41
|
-
def uploads_get_0_with_http_info(opts = {})
|
|
36
|
+
# @return [Array<(DeleteUpload200Response, Integer, Hash)>] DeleteUpload200Response data, response status code and response headers
|
|
37
|
+
def delete_upload_with_http_info(id, opts = {})
|
|
42
38
|
if @api_client.config.debugging
|
|
43
|
-
@api_client.config.logger.debug 'Calling API: UploadsApi.
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: UploadsApi.delete_upload ...'
|
|
44
40
|
end
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
50
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UploadsApi.uploads_get_0, must be greater than or equal to 1.'
|
|
51
|
-
end
|
|
52
|
-
|
|
53
|
-
if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
|
|
54
|
-
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling UploadsApi.uploads_get_0, the character length must be smaller than or equal to 255.'
|
|
41
|
+
# verify the required parameter 'id' is set
|
|
42
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling UploadsApi.delete_upload"
|
|
55
44
|
end
|
|
56
|
-
|
|
57
45
|
# resource path
|
|
58
|
-
local_var_path = '/uploads'
|
|
46
|
+
local_var_path = '/uploads/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
59
47
|
|
|
60
48
|
# query parameters
|
|
61
49
|
query_params = opts[:query_params] || {}
|
|
62
|
-
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
63
|
-
query_params[:'managedUserId'] = opts[:'managed_user_id'] if !opts[:'managed_user_id'].nil?
|
|
64
|
-
query_params[:'managedUserExternalId'] = opts[:'managed_user_external_id'] if !opts[:'managed_user_external_id'].nil?
|
|
65
50
|
|
|
66
51
|
# header parameters
|
|
67
52
|
header_params = opts[:header_params] || {}
|
|
@@ -75,13 +60,13 @@ module ApiSdkRb
|
|
|
75
60
|
post_body = opts[:debug_body]
|
|
76
61
|
|
|
77
62
|
# return_type
|
|
78
|
-
return_type = opts[:debug_return_type] || '
|
|
63
|
+
return_type = opts[:debug_return_type] || 'DeleteUpload200Response'
|
|
79
64
|
|
|
80
65
|
# auth_names
|
|
81
66
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
82
67
|
|
|
83
68
|
new_options = opts.merge(
|
|
84
|
-
:operation => :"UploadsApi.
|
|
69
|
+
:operation => :"UploadsApi.delete_upload",
|
|
85
70
|
:header_params => header_params,
|
|
86
71
|
:query_params => query_params,
|
|
87
72
|
:form_params => form_params,
|
|
@@ -90,35 +75,35 @@ module ApiSdkRb
|
|
|
90
75
|
:return_type => return_type
|
|
91
76
|
)
|
|
92
77
|
|
|
93
|
-
data, status_code, headers = @api_client.call_api(:
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
94
79
|
if @api_client.config.debugging
|
|
95
|
-
@api_client.config.logger.debug "API called: UploadsApi#
|
|
80
|
+
@api_client.config.logger.debug "API called: UploadsApi#delete_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
96
81
|
end
|
|
97
82
|
return data, status_code, headers
|
|
98
83
|
end
|
|
99
84
|
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
# @param id [String]
|
|
85
|
+
# Get an upload by id
|
|
86
|
+
# The details of one of the account's uploads. An upload that belongs to another account is not found.
|
|
87
|
+
# @param id [String] The upload to read
|
|
103
88
|
# @param [Hash] opts the optional parameters
|
|
104
|
-
# @return [
|
|
105
|
-
def
|
|
106
|
-
data, _status_code, _headers =
|
|
89
|
+
# @return [UploadResponse]
|
|
90
|
+
def get_upload(id, opts = {})
|
|
91
|
+
data, _status_code, _headers = get_upload_with_http_info(id, opts)
|
|
107
92
|
data
|
|
108
93
|
end
|
|
109
94
|
|
|
110
|
-
#
|
|
111
|
-
#
|
|
112
|
-
# @param id [String]
|
|
95
|
+
# Get an upload by id
|
|
96
|
+
# The details of one of the account's uploads. An upload that belongs to another account is not found.
|
|
97
|
+
# @param id [String] The upload to read
|
|
113
98
|
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @return [Array<(
|
|
115
|
-
def
|
|
99
|
+
# @return [Array<(UploadResponse, Integer, Hash)>] UploadResponse data, response status code and response headers
|
|
100
|
+
def get_upload_with_http_info(id, opts = {})
|
|
116
101
|
if @api_client.config.debugging
|
|
117
|
-
@api_client.config.logger.debug 'Calling API: UploadsApi.
|
|
102
|
+
@api_client.config.logger.debug 'Calling API: UploadsApi.get_upload ...'
|
|
118
103
|
end
|
|
119
104
|
# verify the required parameter 'id' is set
|
|
120
105
|
if @api_client.config.client_side_validation && id.nil?
|
|
121
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling UploadsApi.
|
|
106
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling UploadsApi.get_upload"
|
|
122
107
|
end
|
|
123
108
|
# resource path
|
|
124
109
|
local_var_path = '/uploads/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
@@ -138,13 +123,13 @@ module ApiSdkRb
|
|
|
138
123
|
post_body = opts[:debug_body]
|
|
139
124
|
|
|
140
125
|
# return_type
|
|
141
|
-
return_type = opts[:debug_return_type] || '
|
|
126
|
+
return_type = opts[:debug_return_type] || 'UploadResponse'
|
|
142
127
|
|
|
143
128
|
# auth_names
|
|
144
129
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
145
130
|
|
|
146
131
|
new_options = opts.merge(
|
|
147
|
-
:operation => :"UploadsApi.
|
|
132
|
+
:operation => :"UploadsApi.get_upload",
|
|
148
133
|
:header_params => header_params,
|
|
149
134
|
:query_params => query_params,
|
|
150
135
|
:form_params => form_params,
|
|
@@ -153,38 +138,32 @@ module ApiSdkRb
|
|
|
153
138
|
:return_type => return_type
|
|
154
139
|
)
|
|
155
140
|
|
|
156
|
-
data, status_code, headers = @api_client.call_api(:
|
|
141
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
157
142
|
if @api_client.config.debugging
|
|
158
|
-
@api_client.config.logger.debug "API called: UploadsApi#
|
|
143
|
+
@api_client.config.logger.debug "API called: UploadsApi#get_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
159
144
|
end
|
|
160
145
|
return data, status_code, headers
|
|
161
146
|
end
|
|
162
147
|
|
|
163
|
-
#
|
|
164
|
-
# The
|
|
165
|
-
# @param id [String] The upload to read
|
|
148
|
+
# Upload size limits and accepted file types
|
|
149
|
+
# The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB).
|
|
166
150
|
# @param [Hash] opts the optional parameters
|
|
167
|
-
# @return [
|
|
168
|
-
def
|
|
169
|
-
data, _status_code, _headers =
|
|
151
|
+
# @return [UploadLimitsResponse]
|
|
152
|
+
def get_upload_limits(opts = {})
|
|
153
|
+
data, _status_code, _headers = get_upload_limits_with_http_info(opts)
|
|
170
154
|
data
|
|
171
155
|
end
|
|
172
156
|
|
|
173
|
-
#
|
|
174
|
-
# The
|
|
175
|
-
# @param id [String] The upload to read
|
|
157
|
+
# Upload size limits and accepted file types
|
|
158
|
+
# The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB).
|
|
176
159
|
# @param [Hash] opts the optional parameters
|
|
177
|
-
# @return [Array<(
|
|
178
|
-
def
|
|
160
|
+
# @return [Array<(UploadLimitsResponse, Integer, Hash)>] UploadLimitsResponse data, response status code and response headers
|
|
161
|
+
def get_upload_limits_with_http_info(opts = {})
|
|
179
162
|
if @api_client.config.debugging
|
|
180
|
-
@api_client.config.logger.debug 'Calling API: UploadsApi.
|
|
181
|
-
end
|
|
182
|
-
# verify the required parameter 'id' is set
|
|
183
|
-
if @api_client.config.client_side_validation && id.nil?
|
|
184
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling UploadsApi.uploads_id_get_0"
|
|
163
|
+
@api_client.config.logger.debug 'Calling API: UploadsApi.get_upload_limits ...'
|
|
185
164
|
end
|
|
186
165
|
# resource path
|
|
187
|
-
local_var_path = '/uploads/
|
|
166
|
+
local_var_path = '/uploads/limits'
|
|
188
167
|
|
|
189
168
|
# query parameters
|
|
190
169
|
query_params = opts[:query_params] || {}
|
|
@@ -201,13 +180,13 @@ module ApiSdkRb
|
|
|
201
180
|
post_body = opts[:debug_body]
|
|
202
181
|
|
|
203
182
|
# return_type
|
|
204
|
-
return_type = opts[:debug_return_type] || '
|
|
183
|
+
return_type = opts[:debug_return_type] || 'UploadLimitsResponse'
|
|
205
184
|
|
|
206
185
|
# auth_names
|
|
207
186
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
208
187
|
|
|
209
188
|
new_options = opts.merge(
|
|
210
|
-
:operation => :"UploadsApi.
|
|
189
|
+
:operation => :"UploadsApi.get_upload_limits",
|
|
211
190
|
:header_params => header_params,
|
|
212
191
|
:query_params => query_params,
|
|
213
192
|
:form_params => form_params,
|
|
@@ -218,33 +197,54 @@ module ApiSdkRb
|
|
|
218
197
|
|
|
219
198
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
220
199
|
if @api_client.config.debugging
|
|
221
|
-
@api_client.config.logger.debug "API called: UploadsApi#
|
|
200
|
+
@api_client.config.logger.debug "API called: UploadsApi#get_upload_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
222
201
|
end
|
|
223
202
|
return data, status_code, headers
|
|
224
203
|
end
|
|
225
204
|
|
|
226
|
-
#
|
|
227
|
-
# The
|
|
205
|
+
# List the account's uploads
|
|
206
|
+
# The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user's files with `managedUserId` or `managedUserExternalId`. The files that visitors sent through a widget's upload adapter (`source` is `widget-visitor-upload`) are not part of this list, so that a popular widget does not push the account's own files out of it; naming one widget with `widgetId` lists what visitors sent to that widget as well.
|
|
228
207
|
# @param [Hash] opts the optional parameters
|
|
229
|
-
# @
|
|
230
|
-
|
|
231
|
-
|
|
208
|
+
# @option opts [Integer] :limit Maximum number of files to return (default to 50)
|
|
209
|
+
# @option opts [String] :managed_user_id List only the files uploaded for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both.
|
|
210
|
+
# @option opts [String] :managed_user_external_id List only the files uploaded for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
|
|
211
|
+
# @return [ListUploads200Response]
|
|
212
|
+
def list_uploads(opts = {})
|
|
213
|
+
data, _status_code, _headers = list_uploads_with_http_info(opts)
|
|
232
214
|
data
|
|
233
215
|
end
|
|
234
216
|
|
|
235
|
-
#
|
|
236
|
-
# The
|
|
217
|
+
# List the account's uploads
|
|
218
|
+
# The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user's files with `managedUserId` or `managedUserExternalId`. The files that visitors sent through a widget's upload adapter (`source` is `widget-visitor-upload`) are not part of this list, so that a popular widget does not push the account's own files out of it; naming one widget with `widgetId` lists what visitors sent to that widget as well.
|
|
237
219
|
# @param [Hash] opts the optional parameters
|
|
238
|
-
# @
|
|
239
|
-
|
|
220
|
+
# @option opts [Integer] :limit Maximum number of files to return (default to 50)
|
|
221
|
+
# @option opts [String] :managed_user_id List only the files uploaded for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both.
|
|
222
|
+
# @option opts [String] :managed_user_external_id List only the files uploaded for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
|
|
223
|
+
# @return [Array<(ListUploads200Response, Integer, Hash)>] ListUploads200Response data, response status code and response headers
|
|
224
|
+
def list_uploads_with_http_info(opts = {})
|
|
240
225
|
if @api_client.config.debugging
|
|
241
|
-
@api_client.config.logger.debug 'Calling API: UploadsApi.
|
|
226
|
+
@api_client.config.logger.debug 'Calling API: UploadsApi.list_uploads ...'
|
|
242
227
|
end
|
|
228
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
229
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UploadsApi.list_uploads, must be smaller than or equal to 100.'
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
233
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UploadsApi.list_uploads, must be greater than or equal to 1.'
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
|
|
237
|
+
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling UploadsApi.list_uploads, the character length must be smaller than or equal to 255.'
|
|
238
|
+
end
|
|
239
|
+
|
|
243
240
|
# resource path
|
|
244
|
-
local_var_path = '/uploads
|
|
241
|
+
local_var_path = '/uploads'
|
|
245
242
|
|
|
246
243
|
# query parameters
|
|
247
244
|
query_params = opts[:query_params] || {}
|
|
245
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
246
|
+
query_params[:'managedUserId'] = opts[:'managed_user_id'] if !opts[:'managed_user_id'].nil?
|
|
247
|
+
query_params[:'managedUserExternalId'] = opts[:'managed_user_external_id'] if !opts[:'managed_user_external_id'].nil?
|
|
248
248
|
|
|
249
249
|
# header parameters
|
|
250
250
|
header_params = opts[:header_params] || {}
|
|
@@ -258,13 +258,13 @@ module ApiSdkRb
|
|
|
258
258
|
post_body = opts[:debug_body]
|
|
259
259
|
|
|
260
260
|
# return_type
|
|
261
|
-
return_type = opts[:debug_return_type] || '
|
|
261
|
+
return_type = opts[:debug_return_type] || 'ListUploads200Response'
|
|
262
262
|
|
|
263
263
|
# auth_names
|
|
264
264
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
265
265
|
|
|
266
266
|
new_options = opts.merge(
|
|
267
|
-
:operation => :"UploadsApi.
|
|
267
|
+
:operation => :"UploadsApi.list_uploads",
|
|
268
268
|
:header_params => header_params,
|
|
269
269
|
:query_params => query_params,
|
|
270
270
|
:form_params => form_params,
|
|
@@ -275,13 +275,13 @@ module ApiSdkRb
|
|
|
275
275
|
|
|
276
276
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
277
277
|
if @api_client.config.debugging
|
|
278
|
-
@api_client.config.logger.debug "API called: UploadsApi#
|
|
278
|
+
@api_client.config.logger.debug "API called: UploadsApi#list_uploads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
279
279
|
end
|
|
280
280
|
return data, status_code, headers
|
|
281
281
|
end
|
|
282
282
|
|
|
283
283
|
# Upload a file
|
|
284
|
-
# Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `
|
|
284
|
+
# Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `getUploadLimits` lists the size limit and the accepted types. A file is judged by what is in it, not by the type it is sent as. A file that is not the type it claims (a web page sent as `image/png`) is refused with 415 and `UPLOAD_UNSUPPORTED_TYPE`, and a picture sent under the wrong picture type is stored under the type it really is, which `mime_type` in the answer says. An SVG is rewritten as it is stored: script, `foreignObject`, animation and references to other addresses are taken out, it must be UTF-8 and at most 2 MB, and the stored file can be larger or smaller than the one sent. Anything that is not an image, audio or video (a PDF, for example) is served as a download rather than shown in a page. When the full storage is a Shopify store's team's, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person's own workspace, get the shorter message. To upload the file for one of your managed users, send `managedUserId` (Widgetic's id for the user) or `managedUserExternalId` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user's files with `listUploads`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards. Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session's own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `contextType`, `source`, `widgetId` and `conversationId` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner's business) and `error.details.limit` is `storage`. An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner's own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner's public address, and its `storage_key` is the key in the partner's bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner's storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`. Partner storage is not optional, and it does not depend on how the file arrives. A partner's own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) and the uploads of its customers' editor sessions are kept in the partner's own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session's browser is only told that the feature is not available right now.
|
|
285
285
|
# @param file [File] The file to store
|
|
286
286
|
# @param [Hash] opts the optional parameters
|
|
287
287
|
# @option opts [String] :context_type What the file is for. Send `content-property` for media that becomes widget content (images, video and PDF); the other values are used by Widgetic's own editor. (default to 'content-property')
|
|
@@ -290,13 +290,13 @@ module ApiSdkRb
|
|
|
290
290
|
# @option opts [String] :managed_user_external_id The same, by your own identifier for the user, the `externalId` you gave when you created the managed user. Send this or `managedUserId`, not both.
|
|
291
291
|
# @option opts [String] :purpose Where in your product you use the file. It is kept with the file, so that a customer's storage can be counted by purpose (`getManagedUserStorageUsage`). Optional; any other value is refused with 400 and `UPLOAD_INVALID_PURPOSE`.
|
|
292
292
|
# @return [UploadResponse]
|
|
293
|
-
def
|
|
294
|
-
data, _status_code, _headers =
|
|
293
|
+
def upload_file(file, opts = {})
|
|
294
|
+
data, _status_code, _headers = upload_file_with_http_info(file, opts)
|
|
295
295
|
data
|
|
296
296
|
end
|
|
297
297
|
|
|
298
298
|
# Upload a file
|
|
299
|
-
# Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `
|
|
299
|
+
# Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `getUploadLimits` lists the size limit and the accepted types. A file is judged by what is in it, not by the type it is sent as. A file that is not the type it claims (a web page sent as `image/png`) is refused with 415 and `UPLOAD_UNSUPPORTED_TYPE`, and a picture sent under the wrong picture type is stored under the type it really is, which `mime_type` in the answer says. An SVG is rewritten as it is stored: script, `foreignObject`, animation and references to other addresses are taken out, it must be UTF-8 and at most 2 MB, and the stored file can be larger or smaller than the one sent. Anything that is not an image, audio or video (a PDF, for example) is served as a download rather than shown in a page. When the full storage is a Shopify store's team's, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person's own workspace, get the shorter message. To upload the file for one of your managed users, send `managedUserId` (Widgetic's id for the user) or `managedUserExternalId` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user's files with `listUploads`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards. Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session's own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `contextType`, `source`, `widgetId` and `conversationId` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner's business) and `error.details.limit` is `storage`. An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner's own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner's public address, and its `storage_key` is the key in the partner's bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner's storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`. Partner storage is not optional, and it does not depend on how the file arrives. A partner's own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) and the uploads of its customers' editor sessions are kept in the partner's own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session's browser is only told that the feature is not available right now.
|
|
300
300
|
# @param file [File] The file to store
|
|
301
301
|
# @param [Hash] opts the optional parameters
|
|
302
302
|
# @option opts [String] :context_type What the file is for. Send `content-property` for media that becomes widget content (images, video and PDF); the other values are used by Widgetic's own editor. (default to 'content-property')
|
|
@@ -305,13 +305,13 @@ module ApiSdkRb
|
|
|
305
305
|
# @option opts [String] :managed_user_external_id The same, by your own identifier for the user, the `externalId` you gave when you created the managed user. Send this or `managedUserId`, not both.
|
|
306
306
|
# @option opts [String] :purpose Where in your product you use the file. It is kept with the file, so that a customer's storage can be counted by purpose (`getManagedUserStorageUsage`). Optional; any other value is refused with 400 and `UPLOAD_INVALID_PURPOSE`.
|
|
307
307
|
# @return [Array<(UploadResponse, Integer, Hash)>] UploadResponse data, response status code and response headers
|
|
308
|
-
def
|
|
308
|
+
def upload_file_with_http_info(file, opts = {})
|
|
309
309
|
if @api_client.config.debugging
|
|
310
|
-
@api_client.config.logger.debug 'Calling API: UploadsApi.
|
|
310
|
+
@api_client.config.logger.debug 'Calling API: UploadsApi.upload_file ...'
|
|
311
311
|
end
|
|
312
312
|
# verify the required parameter 'file' is set
|
|
313
313
|
if @api_client.config.client_side_validation && file.nil?
|
|
314
|
-
fail ArgumentError, "Missing the required parameter 'file' when calling UploadsApi.
|
|
314
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling UploadsApi.upload_file"
|
|
315
315
|
end
|
|
316
316
|
allowable_values = ["widget-codegen", "browser-ic", "content-property"]
|
|
317
317
|
if @api_client.config.client_side_validation && opts[:'context_type'] && !allowable_values.include?(opts[:'context_type'])
|
|
@@ -322,7 +322,7 @@ module ApiSdkRb
|
|
|
322
322
|
fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
|
|
323
323
|
end
|
|
324
324
|
if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
|
|
325
|
-
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling UploadsApi.
|
|
325
|
+
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling UploadsApi.upload_file, the character length must be smaller than or equal to 255.'
|
|
326
326
|
end
|
|
327
327
|
|
|
328
328
|
allowable_values = ["canvas", "chat", "field"]
|
|
@@ -364,7 +364,7 @@ module ApiSdkRb
|
|
|
364
364
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
365
365
|
|
|
366
366
|
new_options = opts.merge(
|
|
367
|
-
:operation => :"UploadsApi.
|
|
367
|
+
:operation => :"UploadsApi.upload_file",
|
|
368
368
|
:header_params => header_params,
|
|
369
369
|
:query_params => query_params,
|
|
370
370
|
:form_params => form_params,
|
|
@@ -375,7 +375,7 @@ module ApiSdkRb
|
|
|
375
375
|
|
|
376
376
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
377
377
|
if @api_client.config.debugging
|
|
378
|
-
@api_client.config.logger.debug "API called: UploadsApi#
|
|
378
|
+
@api_client.config.logger.debug "API called: UploadsApi#upload_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
379
379
|
end
|
|
380
380
|
return data, status_code, headers
|
|
381
381
|
end
|