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/PartnersApi.md
CHANGED
|
@@ -4,52 +4,131 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**
|
|
31
|
-
| [**
|
|
32
|
-
| [**
|
|
33
|
-
| [**
|
|
34
|
-
| [**
|
|
35
|
-
| [**
|
|
36
|
-
| [**
|
|
37
|
-
| [**
|
|
38
|
-
| [**
|
|
39
|
-
| [**
|
|
40
|
-
| [**
|
|
41
|
-
| [**
|
|
42
|
-
| [**
|
|
43
|
-
| [**
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
7
|
+
| [**confirm_partner_adapter_connection**](PartnersApi.md#confirm_partner_adapter_connection) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it |
|
|
8
|
+
| [**create_partner_extra_credits_invoice**](PartnersApi.md#create_partner_extra_credits_invoice) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner |
|
|
9
|
+
| [**get_my_partners**](PartnersApi.md#get_my_partners) | **GET** /partners/mine | Find the partner you administer |
|
|
10
|
+
| [**get_partner_adapter_connections**](PartnersApi.md#get_partner_adapter_connections) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected |
|
|
11
|
+
| [**get_partner_analytics_by_managed_user**](PartnersApi.md#get_partner_analytics_by_managed_user) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did |
|
|
12
|
+
| [**get_partner_analytics_summary**](PartnersApi.md#get_partner_analytics_summary) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets |
|
|
13
|
+
| [**get_partner_analytics_timeline**](PartnersApi.md#get_partner_analytics_timeline) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day |
|
|
14
|
+
| [**get_partner_analytics_top_widgets**](PartnersApi.md#get_partner_analytics_top_widgets) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most |
|
|
15
|
+
| [**get_partner_billing_overview**](PartnersApi.md#get_partner_billing_overview) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview |
|
|
16
|
+
| [**get_partner_contract**](PartnersApi.md#get_partner_contract) | **GET** /partners/{partnerId}/contract | Get a partner's contract |
|
|
17
|
+
| [**get_partner_credit_balance**](PartnersApi.md#get_partner_credit_balance) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance |
|
|
18
|
+
| [**get_partner_credit_transactions**](PartnersApi.md#get_partner_credit_transactions) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history |
|
|
19
|
+
| [**get_partner_data_database**](PartnersApi.md#get_partner_data_database) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in |
|
|
20
|
+
| [**get_partner_design_defaults**](PartnersApi.md#get_partner_design_defaults) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults |
|
|
21
|
+
| [**get_partner_entry_context_signing**](PartnersApi.md#get_partner_entry_context_signing) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed |
|
|
22
|
+
| [**get_partner_notification_settings**](PartnersApi.md#get_partner_notification_settings) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go |
|
|
23
|
+
| [**get_partner_storage_destination**](PartnersApi.md#get_partner_storage_destination) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored |
|
|
24
|
+
| [**get_partner_storage_usage**](PartnersApi.md#get_partner_storage_usage) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store |
|
|
25
|
+
| [**list_partner_notification_deliveries**](PartnersApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you |
|
|
26
|
+
| [**list_partner_notifications**](PartnersApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told |
|
|
27
|
+
| [**list_partner_presets**](PartnersApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets |
|
|
28
|
+
| [**list_partner_workflow_presets**](PartnersApi.md#list_partner_workflow_presets) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start |
|
|
29
|
+
| [**remove_partner_adapter_connection**](PartnersApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner |
|
|
30
|
+
| [**remove_partner_data_database**](PartnersApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database |
|
|
31
|
+
| [**remove_partner_preset**](PartnersApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets |
|
|
32
|
+
| [**remove_partner_storage_destination**](PartnersApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket |
|
|
33
|
+
| [**remove_partner_workflow_preset**](PartnersApi.md#remove_partner_workflow_preset) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start |
|
|
34
|
+
| [**replay_partner_notification_delivery**](PartnersApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again |
|
|
35
|
+
| [**rotate_partner_entry_context_secret**](PartnersApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds |
|
|
36
|
+
| [**rotate_partner_webhook_secret**](PartnersApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook |
|
|
37
|
+
| [**send_partner_notification_test_event**](PartnersApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook |
|
|
38
|
+
| [**set_partner_adapter_connection**](PartnersApi.md#set_partner_adapter_connection) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner |
|
|
39
|
+
| [**set_partner_data_database**](PartnersApi.md#set_partner_data_database) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own |
|
|
40
|
+
| [**set_partner_design_defaults**](PartnersApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults |
|
|
41
|
+
| [**set_partner_preset**](PartnersApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset |
|
|
42
|
+
| [**set_partner_storage_destination**](PartnersApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored |
|
|
43
|
+
| [**set_partner_workflow_preset**](PartnersApi.md#set_partner_workflow_preset) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers |
|
|
44
|
+
| [**update_partner_entry_context_signing**](PartnersApi.md#update_partner_entry_context_signing) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it |
|
|
45
|
+
| [**update_partner_notification_settings**](PartnersApi.md#update_partner_notification_settings) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go |
|
|
46
|
+
| [**verify_partner_data_database**](PartnersApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works |
|
|
47
|
+
| [**verify_partner_storage_destination**](PartnersApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works |
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
## confirm_partner_adapter_connection
|
|
51
|
+
|
|
52
|
+
> <AdapterConnectionResponse> confirm_partner_adapter_connection(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
53
|
+
|
|
54
|
+
Confirm a partner's adapter address with the code that was emailed to it
|
|
55
|
+
|
|
56
|
+
Some credentials are an email address Widgetic sends a widget's messages to (`confirmation: email_code` in `getPartnerAdapterConnections`). Saving one with `setPartnerAdapterConnection` emails a six-digit code to it; this gives the code back. Only then is the address used: until it is confirmed, the widgets of the partner's customers 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 person who administers the partner, or a Widgetic administrator.
|
|
57
|
+
|
|
58
|
+
### Examples
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
require 'time'
|
|
62
|
+
require 'api-sdk-rb'
|
|
63
|
+
# setup authorization
|
|
64
|
+
ApiSdkRb.configure do |config|
|
|
65
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
66
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
api_instance = ApiSdkRb::PartnersApi.new
|
|
70
|
+
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner that keeps the address
|
|
71
|
+
adapter_id = 'adapter_id_example' # String | The adapter the address is for
|
|
72
|
+
credential_key = 'credential_key_example' # String | The credential's name within the adapter
|
|
73
|
+
confirm_adapter_connection_request = ApiSdkRb::ConfirmAdapterConnectionRequest.new({code: '123456'}) # ConfirmAdapterConnectionRequest |
|
|
74
|
+
|
|
75
|
+
begin
|
|
76
|
+
# Confirm a partner's adapter address with the code that was emailed to it
|
|
77
|
+
result = api_instance.confirm_partner_adapter_connection(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
78
|
+
p result
|
|
79
|
+
rescue ApiSdkRb::ApiError => e
|
|
80
|
+
puts "Error when calling PartnersApi->confirm_partner_adapter_connection: #{e}"
|
|
81
|
+
end
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
#### Using the confirm_partner_adapter_connection_with_http_info variant
|
|
85
|
+
|
|
86
|
+
This returns an Array which contains the response data, status code and headers.
|
|
87
|
+
|
|
88
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> confirm_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
89
|
+
|
|
90
|
+
```ruby
|
|
91
|
+
begin
|
|
92
|
+
# Confirm a partner's adapter address with the code that was emailed to it
|
|
93
|
+
data, status_code, headers = api_instance.confirm_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
94
|
+
p status_code # => 2xx
|
|
95
|
+
p headers # => { ... }
|
|
96
|
+
p data # => <AdapterConnectionResponse>
|
|
97
|
+
rescue ApiSdkRb::ApiError => e
|
|
98
|
+
puts "Error when calling PartnersApi->confirm_partner_adapter_connection_with_http_info: #{e}"
|
|
99
|
+
end
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
| Name | Type | Description | Notes |
|
|
105
|
+
| ---- | ---- | ----------- | ----- |
|
|
106
|
+
| **partner_id** | **String** | The partner that keeps the address | |
|
|
107
|
+
| **adapter_id** | **String** | The adapter the address is for | |
|
|
108
|
+
| **credential_key** | **String** | The credential's name within the adapter | |
|
|
109
|
+
| **confirm_adapter_connection_request** | [**ConfirmAdapterConnectionRequest**](ConfirmAdapterConnectionRequest.md) | | |
|
|
110
|
+
|
|
111
|
+
### Return type
|
|
112
|
+
|
|
113
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
114
|
+
|
|
115
|
+
### Authorization
|
|
116
|
+
|
|
117
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
118
|
+
|
|
119
|
+
### HTTP request headers
|
|
120
|
+
|
|
121
|
+
- **Content-Type**: application/json
|
|
122
|
+
- **Accept**: application/json
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
## create_partner_extra_credits_invoice
|
|
126
|
+
|
|
127
|
+
> <PartnerExtraCreditsInvoiceResponse> create_partner_extra_credits_invoice(partner_id, idempotency_key, request_extra_credits)
|
|
49
128
|
|
|
50
129
|
Buy extra credits for a partner
|
|
51
130
|
|
|
52
|
-
Asks Widgetic for an invoice for extra credits, on top of the credits of the contract. Name the dollars; the invoice is for the most whole credits they buy at the **list price** of a credit (the price a contract may lower belongs to the contract), so it is never for more than you asked: 12.34 buys 123 credits and the invoice says 12.30. The smallest purchase is 10 dollars and one request buys at most 100000 (ask Widgetic for an invoice for more). Pay the invoice with the link in the answer. When it is paid the credits are added **once, for good**, to the account of the person who administers the partner, which is the account everything the partner builds is charged to (`getPartnerCreditBalance` shows it). Extra credits **do not expire**, unlike the credits of a contract period, which end with it. Nothing is added before the invoice is paid, and an unpaid invoice for extra credits never stops the partner: only an unpaid invoice of the contract does (`payment_arrears`).
|
|
131
|
+
Asks Widgetic for an invoice for extra credits, on top of the credits of the contract. Name the dollars; the invoice is for the most whole credits they buy at the **list price** of a credit (the price a contract may lower belongs to the contract), so it is never for more than you asked: 12.34 buys 123 credits and the invoice says 12.30. The smallest purchase is 10 dollars and one request buys at most 100000 (ask Widgetic for an invoice for more). Pay the invoice with the link in the answer. When it is paid the credits are added **once, for good**, to the account of the person who administers the partner, which is the account everything the partner builds is charged to (`getPartnerCreditBalance` shows it). Extra credits **do not expire**, unlike the credits of a contract period, which end with it. Nothing is added before the invoice is paid, and an unpaid invoice for extra credits never stops the partner: only an unpaid invoice of the contract does (`payment_arrears`). Available only to partners that have an active paid contract in force with Widgetic (`NO_PAID_CONTRACT` when none is in force) and no overdue contract invoice (`CONTRACT_INVOICE_OVERDUE` while a contract invoice is past its due day). A partner that has run out of credits during its period can buy more at the list price. An `Idempotency-Key` is required, and it is what makes a retry safe: the same key with the same body returns the invoice already issued, the same key with a different body is refused with 422, and a duplicate that arrives while the first is still running is refused with 409. Use one key per purchase you mean to make, and a new key for the next one. At most 10 requests an hour. Who may ask: the person who administers the partner, or a Widgetic administrator. A key limited to scopes needs `billing:write`.
|
|
53
132
|
|
|
54
133
|
### Examples
|
|
55
134
|
|
|
@@ -69,28 +148,28 @@ request_extra_credits = ApiSdkRb::RequestExtraCredits.new({usd: 250}) # RequestE
|
|
|
69
148
|
|
|
70
149
|
begin
|
|
71
150
|
# Buy extra credits for a partner
|
|
72
|
-
result = api_instance.
|
|
151
|
+
result = api_instance.create_partner_extra_credits_invoice(partner_id, idempotency_key, request_extra_credits)
|
|
73
152
|
p result
|
|
74
153
|
rescue ApiSdkRb::ApiError => e
|
|
75
|
-
puts "Error when calling PartnersApi->
|
|
154
|
+
puts "Error when calling PartnersApi->create_partner_extra_credits_invoice: #{e}"
|
|
76
155
|
end
|
|
77
156
|
```
|
|
78
157
|
|
|
79
|
-
#### Using the
|
|
158
|
+
#### Using the create_partner_extra_credits_invoice_with_http_info variant
|
|
80
159
|
|
|
81
160
|
This returns an Array which contains the response data, status code and headers.
|
|
82
161
|
|
|
83
|
-
> <Array(<PartnerExtraCreditsInvoiceResponse>, Integer, Hash)>
|
|
162
|
+
> <Array(<PartnerExtraCreditsInvoiceResponse>, Integer, Hash)> create_partner_extra_credits_invoice_with_http_info(partner_id, idempotency_key, request_extra_credits)
|
|
84
163
|
|
|
85
164
|
```ruby
|
|
86
165
|
begin
|
|
87
166
|
# Buy extra credits for a partner
|
|
88
|
-
data, status_code, headers = api_instance.
|
|
167
|
+
data, status_code, headers = api_instance.create_partner_extra_credits_invoice_with_http_info(partner_id, idempotency_key, request_extra_credits)
|
|
89
168
|
p status_code # => 2xx
|
|
90
169
|
p headers # => { ... }
|
|
91
170
|
p data # => <PartnerExtraCreditsInvoiceResponse>
|
|
92
171
|
rescue ApiSdkRb::ApiError => e
|
|
93
|
-
puts "Error when calling PartnersApi->
|
|
172
|
+
puts "Error when calling PartnersApi->create_partner_extra_credits_invoice_with_http_info: #{e}"
|
|
94
173
|
end
|
|
95
174
|
```
|
|
96
175
|
|
|
@@ -116,9 +195,9 @@ end
|
|
|
116
195
|
- **Accept**: application/json
|
|
117
196
|
|
|
118
197
|
|
|
119
|
-
##
|
|
198
|
+
## get_my_partners
|
|
120
199
|
|
|
121
|
-
> <MyPartnersResponse>
|
|
200
|
+
> <MyPartnersResponse> get_my_partners
|
|
122
201
|
|
|
123
202
|
Find the partner you administer
|
|
124
203
|
|
|
@@ -139,28 +218,28 @@ api_instance = ApiSdkRb::PartnersApi.new
|
|
|
139
218
|
|
|
140
219
|
begin
|
|
141
220
|
# Find the partner you administer
|
|
142
|
-
result = api_instance.
|
|
221
|
+
result = api_instance.get_my_partners
|
|
143
222
|
p result
|
|
144
223
|
rescue ApiSdkRb::ApiError => e
|
|
145
|
-
puts "Error when calling PartnersApi->
|
|
224
|
+
puts "Error when calling PartnersApi->get_my_partners: #{e}"
|
|
146
225
|
end
|
|
147
226
|
```
|
|
148
227
|
|
|
149
|
-
#### Using the
|
|
228
|
+
#### Using the get_my_partners_with_http_info variant
|
|
150
229
|
|
|
151
230
|
This returns an Array which contains the response data, status code and headers.
|
|
152
231
|
|
|
153
|
-
> <Array(<MyPartnersResponse>, Integer, Hash)>
|
|
232
|
+
> <Array(<MyPartnersResponse>, Integer, Hash)> get_my_partners_with_http_info
|
|
154
233
|
|
|
155
234
|
```ruby
|
|
156
235
|
begin
|
|
157
236
|
# Find the partner you administer
|
|
158
|
-
data, status_code, headers = api_instance.
|
|
237
|
+
data, status_code, headers = api_instance.get_my_partners_with_http_info
|
|
159
238
|
p status_code # => 2xx
|
|
160
239
|
p headers # => { ... }
|
|
161
240
|
p data # => <MyPartnersResponse>
|
|
162
241
|
rescue ApiSdkRb::ApiError => e
|
|
163
|
-
puts "Error when calling PartnersApi->
|
|
242
|
+
puts "Error when calling PartnersApi->get_my_partners_with_http_info: #{e}"
|
|
164
243
|
end
|
|
165
244
|
```
|
|
166
245
|
|
|
@@ -182,9 +261,9 @@ This endpoint does not need any parameter.
|
|
|
182
261
|
- **Accept**: application/json
|
|
183
262
|
|
|
184
263
|
|
|
185
|
-
##
|
|
264
|
+
## get_partner_adapter_connections
|
|
186
265
|
|
|
187
|
-
> <
|
|
266
|
+
> <AdapterConnectionListResponse> get_partner_adapter_connections(partner_id)
|
|
188
267
|
|
|
189
268
|
See which adapter keys a partner has connected
|
|
190
269
|
|
|
@@ -206,28 +285,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
206
285
|
|
|
207
286
|
begin
|
|
208
287
|
# See which adapter keys a partner has connected
|
|
209
|
-
result = api_instance.
|
|
288
|
+
result = api_instance.get_partner_adapter_connections(partner_id)
|
|
210
289
|
p result
|
|
211
290
|
rescue ApiSdkRb::ApiError => e
|
|
212
|
-
puts "Error when calling PartnersApi->
|
|
291
|
+
puts "Error when calling PartnersApi->get_partner_adapter_connections: #{e}"
|
|
213
292
|
end
|
|
214
293
|
```
|
|
215
294
|
|
|
216
|
-
#### Using the
|
|
295
|
+
#### Using the get_partner_adapter_connections_with_http_info variant
|
|
217
296
|
|
|
218
297
|
This returns an Array which contains the response data, status code and headers.
|
|
219
298
|
|
|
220
|
-
> <Array(<
|
|
299
|
+
> <Array(<AdapterConnectionListResponse>, Integer, Hash)> get_partner_adapter_connections_with_http_info(partner_id)
|
|
221
300
|
|
|
222
301
|
```ruby
|
|
223
302
|
begin
|
|
224
303
|
# See which adapter keys a partner has connected
|
|
225
|
-
data, status_code, headers = api_instance.
|
|
304
|
+
data, status_code, headers = api_instance.get_partner_adapter_connections_with_http_info(partner_id)
|
|
226
305
|
p status_code # => 2xx
|
|
227
306
|
p headers # => { ... }
|
|
228
|
-
p data # => <
|
|
307
|
+
p data # => <AdapterConnectionListResponse>
|
|
229
308
|
rescue ApiSdkRb::ApiError => e
|
|
230
|
-
puts "Error when calling PartnersApi->
|
|
309
|
+
puts "Error when calling PartnersApi->get_partner_adapter_connections_with_http_info: #{e}"
|
|
231
310
|
end
|
|
232
311
|
```
|
|
233
312
|
|
|
@@ -239,7 +318,7 @@ end
|
|
|
239
318
|
|
|
240
319
|
### Return type
|
|
241
320
|
|
|
242
|
-
[**
|
|
321
|
+
[**AdapterConnectionListResponse**](AdapterConnectionListResponse.md)
|
|
243
322
|
|
|
244
323
|
### Authorization
|
|
245
324
|
|
|
@@ -251,9 +330,9 @@ end
|
|
|
251
330
|
- **Accept**: application/json
|
|
252
331
|
|
|
253
332
|
|
|
254
|
-
##
|
|
333
|
+
## get_partner_analytics_by_managed_user
|
|
255
334
|
|
|
256
|
-
> <PartnerAnalyticsByManagedUserResponse>
|
|
335
|
+
> <PartnerAnalyticsByManagedUserResponse> get_partner_analytics_by_managed_user(partner_id, opts)
|
|
257
336
|
|
|
258
337
|
What each managed user's widgets did
|
|
259
338
|
|
|
@@ -281,28 +360,28 @@ opts = {
|
|
|
281
360
|
|
|
282
361
|
begin
|
|
283
362
|
# What each managed user's widgets did
|
|
284
|
-
result = api_instance.
|
|
363
|
+
result = api_instance.get_partner_analytics_by_managed_user(partner_id, opts)
|
|
285
364
|
p result
|
|
286
365
|
rescue ApiSdkRb::ApiError => e
|
|
287
|
-
puts "Error when calling PartnersApi->
|
|
366
|
+
puts "Error when calling PartnersApi->get_partner_analytics_by_managed_user: #{e}"
|
|
288
367
|
end
|
|
289
368
|
```
|
|
290
369
|
|
|
291
|
-
#### Using the
|
|
370
|
+
#### Using the get_partner_analytics_by_managed_user_with_http_info variant
|
|
292
371
|
|
|
293
372
|
This returns an Array which contains the response data, status code and headers.
|
|
294
373
|
|
|
295
|
-
> <Array(<PartnerAnalyticsByManagedUserResponse>, Integer, Hash)>
|
|
374
|
+
> <Array(<PartnerAnalyticsByManagedUserResponse>, Integer, Hash)> get_partner_analytics_by_managed_user_with_http_info(partner_id, opts)
|
|
296
375
|
|
|
297
376
|
```ruby
|
|
298
377
|
begin
|
|
299
378
|
# What each managed user's widgets did
|
|
300
|
-
data, status_code, headers = api_instance.
|
|
379
|
+
data, status_code, headers = api_instance.get_partner_analytics_by_managed_user_with_http_info(partner_id, opts)
|
|
301
380
|
p status_code # => 2xx
|
|
302
381
|
p headers # => { ... }
|
|
303
382
|
p data # => <PartnerAnalyticsByManagedUserResponse>
|
|
304
383
|
rescue ApiSdkRb::ApiError => e
|
|
305
|
-
puts "Error when calling PartnersApi->
|
|
384
|
+
puts "Error when calling PartnersApi->get_partner_analytics_by_managed_user_with_http_info: #{e}"
|
|
306
385
|
end
|
|
307
386
|
```
|
|
308
387
|
|
|
@@ -330,9 +409,9 @@ end
|
|
|
330
409
|
- **Accept**: application/json
|
|
331
410
|
|
|
332
411
|
|
|
333
|
-
##
|
|
412
|
+
## get_partner_analytics_summary
|
|
334
413
|
|
|
335
|
-
> <PartnerAnalyticsSummaryResponse>
|
|
414
|
+
> <PartnerAnalyticsSummaryResponse> get_partner_analytics_summary(partner_id, opts)
|
|
336
415
|
|
|
337
416
|
What was done with a partner's published widgets
|
|
338
417
|
|
|
@@ -360,28 +439,28 @@ opts = {
|
|
|
360
439
|
|
|
361
440
|
begin
|
|
362
441
|
# What was done with a partner's published widgets
|
|
363
|
-
result = api_instance.
|
|
442
|
+
result = api_instance.get_partner_analytics_summary(partner_id, opts)
|
|
364
443
|
p result
|
|
365
444
|
rescue ApiSdkRb::ApiError => e
|
|
366
|
-
puts "Error when calling PartnersApi->
|
|
445
|
+
puts "Error when calling PartnersApi->get_partner_analytics_summary: #{e}"
|
|
367
446
|
end
|
|
368
447
|
```
|
|
369
448
|
|
|
370
|
-
#### Using the
|
|
449
|
+
#### Using the get_partner_analytics_summary_with_http_info variant
|
|
371
450
|
|
|
372
451
|
This returns an Array which contains the response data, status code and headers.
|
|
373
452
|
|
|
374
|
-
> <Array(<PartnerAnalyticsSummaryResponse>, Integer, Hash)>
|
|
453
|
+
> <Array(<PartnerAnalyticsSummaryResponse>, Integer, Hash)> get_partner_analytics_summary_with_http_info(partner_id, opts)
|
|
375
454
|
|
|
376
455
|
```ruby
|
|
377
456
|
begin
|
|
378
457
|
# What was done with a partner's published widgets
|
|
379
|
-
data, status_code, headers = api_instance.
|
|
458
|
+
data, status_code, headers = api_instance.get_partner_analytics_summary_with_http_info(partner_id, opts)
|
|
380
459
|
p status_code # => 2xx
|
|
381
460
|
p headers # => { ... }
|
|
382
461
|
p data # => <PartnerAnalyticsSummaryResponse>
|
|
383
462
|
rescue ApiSdkRb::ApiError => e
|
|
384
|
-
puts "Error when calling PartnersApi->
|
|
463
|
+
puts "Error when calling PartnersApi->get_partner_analytics_summary_with_http_info: #{e}"
|
|
385
464
|
end
|
|
386
465
|
```
|
|
387
466
|
|
|
@@ -409,9 +488,9 @@ end
|
|
|
409
488
|
- **Accept**: application/json
|
|
410
489
|
|
|
411
490
|
|
|
412
|
-
##
|
|
491
|
+
## get_partner_analytics_timeline
|
|
413
492
|
|
|
414
|
-
> <PartnerAnalyticsTimelineResponse>
|
|
493
|
+
> <PartnerAnalyticsTimelineResponse> get_partner_analytics_timeline(partner_id, opts)
|
|
415
494
|
|
|
416
495
|
What was done with a partner's widgets, day by day
|
|
417
496
|
|
|
@@ -439,28 +518,28 @@ opts = {
|
|
|
439
518
|
|
|
440
519
|
begin
|
|
441
520
|
# What was done with a partner's widgets, day by day
|
|
442
|
-
result = api_instance.
|
|
521
|
+
result = api_instance.get_partner_analytics_timeline(partner_id, opts)
|
|
443
522
|
p result
|
|
444
523
|
rescue ApiSdkRb::ApiError => e
|
|
445
|
-
puts "Error when calling PartnersApi->
|
|
524
|
+
puts "Error when calling PartnersApi->get_partner_analytics_timeline: #{e}"
|
|
446
525
|
end
|
|
447
526
|
```
|
|
448
527
|
|
|
449
|
-
#### Using the
|
|
528
|
+
#### Using the get_partner_analytics_timeline_with_http_info variant
|
|
450
529
|
|
|
451
530
|
This returns an Array which contains the response data, status code and headers.
|
|
452
531
|
|
|
453
|
-
> <Array(<PartnerAnalyticsTimelineResponse>, Integer, Hash)>
|
|
532
|
+
> <Array(<PartnerAnalyticsTimelineResponse>, Integer, Hash)> get_partner_analytics_timeline_with_http_info(partner_id, opts)
|
|
454
533
|
|
|
455
534
|
```ruby
|
|
456
535
|
begin
|
|
457
536
|
# What was done with a partner's widgets, day by day
|
|
458
|
-
data, status_code, headers = api_instance.
|
|
537
|
+
data, status_code, headers = api_instance.get_partner_analytics_timeline_with_http_info(partner_id, opts)
|
|
459
538
|
p status_code # => 2xx
|
|
460
539
|
p headers # => { ... }
|
|
461
540
|
p data # => <PartnerAnalyticsTimelineResponse>
|
|
462
541
|
rescue ApiSdkRb::ApiError => e
|
|
463
|
-
puts "Error when calling PartnersApi->
|
|
542
|
+
puts "Error when calling PartnersApi->get_partner_analytics_timeline_with_http_info: #{e}"
|
|
464
543
|
end
|
|
465
544
|
```
|
|
466
545
|
|
|
@@ -488,9 +567,9 @@ end
|
|
|
488
567
|
- **Accept**: application/json
|
|
489
568
|
|
|
490
569
|
|
|
491
|
-
##
|
|
570
|
+
## get_partner_analytics_top_widgets
|
|
492
571
|
|
|
493
|
-
> <PartnerAnalyticsTopWidgetsResponse>
|
|
572
|
+
> <PartnerAnalyticsTopWidgetsResponse> get_partner_analytics_top_widgets(partner_id, opts)
|
|
494
573
|
|
|
495
574
|
Which widgets were viewed the most
|
|
496
575
|
|
|
@@ -519,28 +598,28 @@ opts = {
|
|
|
519
598
|
|
|
520
599
|
begin
|
|
521
600
|
# Which widgets were viewed the most
|
|
522
|
-
result = api_instance.
|
|
601
|
+
result = api_instance.get_partner_analytics_top_widgets(partner_id, opts)
|
|
523
602
|
p result
|
|
524
603
|
rescue ApiSdkRb::ApiError => e
|
|
525
|
-
puts "Error when calling PartnersApi->
|
|
604
|
+
puts "Error when calling PartnersApi->get_partner_analytics_top_widgets: #{e}"
|
|
526
605
|
end
|
|
527
606
|
```
|
|
528
607
|
|
|
529
|
-
#### Using the
|
|
608
|
+
#### Using the get_partner_analytics_top_widgets_with_http_info variant
|
|
530
609
|
|
|
531
610
|
This returns an Array which contains the response data, status code and headers.
|
|
532
611
|
|
|
533
|
-
> <Array(<PartnerAnalyticsTopWidgetsResponse>, Integer, Hash)>
|
|
612
|
+
> <Array(<PartnerAnalyticsTopWidgetsResponse>, Integer, Hash)> get_partner_analytics_top_widgets_with_http_info(partner_id, opts)
|
|
534
613
|
|
|
535
614
|
```ruby
|
|
536
615
|
begin
|
|
537
616
|
# Which widgets were viewed the most
|
|
538
|
-
data, status_code, headers = api_instance.
|
|
617
|
+
data, status_code, headers = api_instance.get_partner_analytics_top_widgets_with_http_info(partner_id, opts)
|
|
539
618
|
p status_code # => 2xx
|
|
540
619
|
p headers # => { ... }
|
|
541
620
|
p data # => <PartnerAnalyticsTopWidgetsResponse>
|
|
542
621
|
rescue ApiSdkRb::ApiError => e
|
|
543
|
-
puts "Error when calling PartnersApi->
|
|
622
|
+
puts "Error when calling PartnersApi->get_partner_analytics_top_widgets_with_http_info: #{e}"
|
|
544
623
|
end
|
|
545
624
|
```
|
|
546
625
|
|
|
@@ -569,9 +648,9 @@ end
|
|
|
569
648
|
- **Accept**: application/json
|
|
570
649
|
|
|
571
650
|
|
|
572
|
-
##
|
|
651
|
+
## get_partner_billing_overview
|
|
573
652
|
|
|
574
|
-
> <GetPartnerBillingOverview200Response>
|
|
653
|
+
> <GetPartnerBillingOverview200Response> get_partner_billing_overview(partner_id)
|
|
575
654
|
|
|
576
655
|
Get comprehensive partner billing overview
|
|
577
656
|
|
|
@@ -593,28 +672,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Partner ID
|
|
|
593
672
|
|
|
594
673
|
begin
|
|
595
674
|
# Get comprehensive partner billing overview
|
|
596
|
-
result = api_instance.
|
|
675
|
+
result = api_instance.get_partner_billing_overview(partner_id)
|
|
597
676
|
p result
|
|
598
677
|
rescue ApiSdkRb::ApiError => e
|
|
599
|
-
puts "Error when calling PartnersApi->
|
|
678
|
+
puts "Error when calling PartnersApi->get_partner_billing_overview: #{e}"
|
|
600
679
|
end
|
|
601
680
|
```
|
|
602
681
|
|
|
603
|
-
#### Using the
|
|
682
|
+
#### Using the get_partner_billing_overview_with_http_info variant
|
|
604
683
|
|
|
605
684
|
This returns an Array which contains the response data, status code and headers.
|
|
606
685
|
|
|
607
|
-
> <Array(<GetPartnerBillingOverview200Response>, Integer, Hash)>
|
|
686
|
+
> <Array(<GetPartnerBillingOverview200Response>, Integer, Hash)> get_partner_billing_overview_with_http_info(partner_id)
|
|
608
687
|
|
|
609
688
|
```ruby
|
|
610
689
|
begin
|
|
611
690
|
# Get comprehensive partner billing overview
|
|
612
|
-
data, status_code, headers = api_instance.
|
|
691
|
+
data, status_code, headers = api_instance.get_partner_billing_overview_with_http_info(partner_id)
|
|
613
692
|
p status_code # => 2xx
|
|
614
693
|
p headers # => { ... }
|
|
615
694
|
p data # => <GetPartnerBillingOverview200Response>
|
|
616
695
|
rescue ApiSdkRb::ApiError => e
|
|
617
|
-
puts "Error when calling PartnersApi->
|
|
696
|
+
puts "Error when calling PartnersApi->get_partner_billing_overview_with_http_info: #{e}"
|
|
618
697
|
end
|
|
619
698
|
```
|
|
620
699
|
|
|
@@ -638,9 +717,9 @@ end
|
|
|
638
717
|
- **Accept**: application/json
|
|
639
718
|
|
|
640
719
|
|
|
641
|
-
##
|
|
720
|
+
## get_partner_contract
|
|
642
721
|
|
|
643
|
-
> <PartnerContractResponse>
|
|
722
|
+
> <PartnerContractResponse> get_partner_contract(partner_id)
|
|
644
723
|
|
|
645
724
|
Get a partner's contract
|
|
646
725
|
|
|
@@ -662,28 +741,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
662
741
|
|
|
663
742
|
begin
|
|
664
743
|
# Get a partner's contract
|
|
665
|
-
result = api_instance.
|
|
744
|
+
result = api_instance.get_partner_contract(partner_id)
|
|
666
745
|
p result
|
|
667
746
|
rescue ApiSdkRb::ApiError => e
|
|
668
|
-
puts "Error when calling PartnersApi->
|
|
747
|
+
puts "Error when calling PartnersApi->get_partner_contract: #{e}"
|
|
669
748
|
end
|
|
670
749
|
```
|
|
671
750
|
|
|
672
|
-
#### Using the
|
|
751
|
+
#### Using the get_partner_contract_with_http_info variant
|
|
673
752
|
|
|
674
753
|
This returns an Array which contains the response data, status code and headers.
|
|
675
754
|
|
|
676
|
-
> <Array(<PartnerContractResponse>, Integer, Hash)>
|
|
755
|
+
> <Array(<PartnerContractResponse>, Integer, Hash)> get_partner_contract_with_http_info(partner_id)
|
|
677
756
|
|
|
678
757
|
```ruby
|
|
679
758
|
begin
|
|
680
759
|
# Get a partner's contract
|
|
681
|
-
data, status_code, headers = api_instance.
|
|
760
|
+
data, status_code, headers = api_instance.get_partner_contract_with_http_info(partner_id)
|
|
682
761
|
p status_code # => 2xx
|
|
683
762
|
p headers # => { ... }
|
|
684
763
|
p data # => <PartnerContractResponse>
|
|
685
764
|
rescue ApiSdkRb::ApiError => e
|
|
686
|
-
puts "Error when calling PartnersApi->
|
|
765
|
+
puts "Error when calling PartnersApi->get_partner_contract_with_http_info: #{e}"
|
|
687
766
|
end
|
|
688
767
|
```
|
|
689
768
|
|
|
@@ -707,9 +786,9 @@ end
|
|
|
707
786
|
- **Accept**: application/json
|
|
708
787
|
|
|
709
788
|
|
|
710
|
-
##
|
|
789
|
+
## get_partner_credit_balance
|
|
711
790
|
|
|
712
|
-
> <AccountCreditBalanceResponse>
|
|
791
|
+
> <AccountCreditBalanceResponse> get_partner_credit_balance(partner_id)
|
|
713
792
|
|
|
714
793
|
Get partner credit balance
|
|
715
794
|
|
|
@@ -731,28 +810,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Partner ID
|
|
|
731
810
|
|
|
732
811
|
begin
|
|
733
812
|
# Get partner credit balance
|
|
734
|
-
result = api_instance.
|
|
813
|
+
result = api_instance.get_partner_credit_balance(partner_id)
|
|
735
814
|
p result
|
|
736
815
|
rescue ApiSdkRb::ApiError => e
|
|
737
|
-
puts "Error when calling PartnersApi->
|
|
816
|
+
puts "Error when calling PartnersApi->get_partner_credit_balance: #{e}"
|
|
738
817
|
end
|
|
739
818
|
```
|
|
740
819
|
|
|
741
|
-
#### Using the
|
|
820
|
+
#### Using the get_partner_credit_balance_with_http_info variant
|
|
742
821
|
|
|
743
822
|
This returns an Array which contains the response data, status code and headers.
|
|
744
823
|
|
|
745
|
-
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)>
|
|
824
|
+
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)> get_partner_credit_balance_with_http_info(partner_id)
|
|
746
825
|
|
|
747
826
|
```ruby
|
|
748
827
|
begin
|
|
749
828
|
# Get partner credit balance
|
|
750
|
-
data, status_code, headers = api_instance.
|
|
829
|
+
data, status_code, headers = api_instance.get_partner_credit_balance_with_http_info(partner_id)
|
|
751
830
|
p status_code # => 2xx
|
|
752
831
|
p headers # => { ... }
|
|
753
832
|
p data # => <AccountCreditBalanceResponse>
|
|
754
833
|
rescue ApiSdkRb::ApiError => e
|
|
755
|
-
puts "Error when calling PartnersApi->
|
|
834
|
+
puts "Error when calling PartnersApi->get_partner_credit_balance_with_http_info: #{e}"
|
|
756
835
|
end
|
|
757
836
|
```
|
|
758
837
|
|
|
@@ -776,9 +855,9 @@ end
|
|
|
776
855
|
- **Accept**: application/json
|
|
777
856
|
|
|
778
857
|
|
|
779
|
-
##
|
|
858
|
+
## get_partner_credit_transactions
|
|
780
859
|
|
|
781
|
-
> <
|
|
860
|
+
> <AccountCreditTransactionListResponse> get_partner_credit_transactions(partner_id, opts)
|
|
782
861
|
|
|
783
862
|
Get partner credit transaction history
|
|
784
863
|
|
|
@@ -805,28 +884,28 @@ opts = {
|
|
|
805
884
|
|
|
806
885
|
begin
|
|
807
886
|
# Get partner credit transaction history
|
|
808
|
-
result = api_instance.
|
|
887
|
+
result = api_instance.get_partner_credit_transactions(partner_id, opts)
|
|
809
888
|
p result
|
|
810
889
|
rescue ApiSdkRb::ApiError => e
|
|
811
|
-
puts "Error when calling PartnersApi->
|
|
890
|
+
puts "Error when calling PartnersApi->get_partner_credit_transactions: #{e}"
|
|
812
891
|
end
|
|
813
892
|
```
|
|
814
893
|
|
|
815
|
-
#### Using the
|
|
894
|
+
#### Using the get_partner_credit_transactions_with_http_info variant
|
|
816
895
|
|
|
817
896
|
This returns an Array which contains the response data, status code and headers.
|
|
818
897
|
|
|
819
|
-
> <Array(<
|
|
898
|
+
> <Array(<AccountCreditTransactionListResponse>, Integer, Hash)> get_partner_credit_transactions_with_http_info(partner_id, opts)
|
|
820
899
|
|
|
821
900
|
```ruby
|
|
822
901
|
begin
|
|
823
902
|
# Get partner credit transaction history
|
|
824
|
-
data, status_code, headers = api_instance.
|
|
903
|
+
data, status_code, headers = api_instance.get_partner_credit_transactions_with_http_info(partner_id, opts)
|
|
825
904
|
p status_code # => 2xx
|
|
826
905
|
p headers # => { ... }
|
|
827
|
-
p data # => <
|
|
906
|
+
p data # => <AccountCreditTransactionListResponse>
|
|
828
907
|
rescue ApiSdkRb::ApiError => e
|
|
829
|
-
puts "Error when calling PartnersApi->
|
|
908
|
+
puts "Error when calling PartnersApi->get_partner_credit_transactions_with_http_info: #{e}"
|
|
830
909
|
end
|
|
831
910
|
```
|
|
832
911
|
|
|
@@ -841,7 +920,7 @@ end
|
|
|
841
920
|
|
|
842
921
|
### Return type
|
|
843
922
|
|
|
844
|
-
[**
|
|
923
|
+
[**AccountCreditTransactionListResponse**](AccountCreditTransactionListResponse.md)
|
|
845
924
|
|
|
846
925
|
### Authorization
|
|
847
926
|
|
|
@@ -853,9 +932,9 @@ end
|
|
|
853
932
|
- **Accept**: application/json
|
|
854
933
|
|
|
855
934
|
|
|
856
|
-
##
|
|
935
|
+
## get_partner_data_database
|
|
857
936
|
|
|
858
|
-
> <PartnerDataDatabaseResponse>
|
|
937
|
+
> <PartnerDataDatabaseResponse> get_partner_data_database(partner_id)
|
|
859
938
|
|
|
860
939
|
See the Neon database a partner keeps the data of its compositions in
|
|
861
940
|
|
|
@@ -877,28 +956,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
877
956
|
|
|
878
957
|
begin
|
|
879
958
|
# See the Neon database a partner keeps the data of its compositions in
|
|
880
|
-
result = api_instance.
|
|
959
|
+
result = api_instance.get_partner_data_database(partner_id)
|
|
881
960
|
p result
|
|
882
961
|
rescue ApiSdkRb::ApiError => e
|
|
883
|
-
puts "Error when calling PartnersApi->
|
|
962
|
+
puts "Error when calling PartnersApi->get_partner_data_database: #{e}"
|
|
884
963
|
end
|
|
885
964
|
```
|
|
886
965
|
|
|
887
|
-
#### Using the
|
|
966
|
+
#### Using the get_partner_data_database_with_http_info variant
|
|
888
967
|
|
|
889
968
|
This returns an Array which contains the response data, status code and headers.
|
|
890
969
|
|
|
891
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
970
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> get_partner_data_database_with_http_info(partner_id)
|
|
892
971
|
|
|
893
972
|
```ruby
|
|
894
973
|
begin
|
|
895
974
|
# See the Neon database a partner keeps the data of its compositions in
|
|
896
|
-
data, status_code, headers = api_instance.
|
|
975
|
+
data, status_code, headers = api_instance.get_partner_data_database_with_http_info(partner_id)
|
|
897
976
|
p status_code # => 2xx
|
|
898
977
|
p headers # => { ... }
|
|
899
978
|
p data # => <PartnerDataDatabaseResponse>
|
|
900
979
|
rescue ApiSdkRb::ApiError => e
|
|
901
|
-
puts "Error when calling PartnersApi->
|
|
980
|
+
puts "Error when calling PartnersApi->get_partner_data_database_with_http_info: #{e}"
|
|
902
981
|
end
|
|
903
982
|
```
|
|
904
983
|
|
|
@@ -922,9 +1001,9 @@ end
|
|
|
922
1001
|
- **Accept**: application/json
|
|
923
1002
|
|
|
924
1003
|
|
|
925
|
-
##
|
|
1004
|
+
## get_partner_design_defaults
|
|
926
1005
|
|
|
927
|
-
> <
|
|
1006
|
+
> <DesignDefaultsResponse> get_partner_design_defaults(partner_id)
|
|
928
1007
|
|
|
929
1008
|
Read partner-wide design defaults
|
|
930
1009
|
|
|
@@ -944,28 +1023,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
944
1023
|
|
|
945
1024
|
begin
|
|
946
1025
|
# Read partner-wide design defaults
|
|
947
|
-
result = api_instance.
|
|
1026
|
+
result = api_instance.get_partner_design_defaults(partner_id)
|
|
948
1027
|
p result
|
|
949
1028
|
rescue ApiSdkRb::ApiError => e
|
|
950
|
-
puts "Error when calling PartnersApi->
|
|
1029
|
+
puts "Error when calling PartnersApi->get_partner_design_defaults: #{e}"
|
|
951
1030
|
end
|
|
952
1031
|
```
|
|
953
1032
|
|
|
954
|
-
#### Using the
|
|
1033
|
+
#### Using the get_partner_design_defaults_with_http_info variant
|
|
955
1034
|
|
|
956
1035
|
This returns an Array which contains the response data, status code and headers.
|
|
957
1036
|
|
|
958
|
-
> <Array(<
|
|
1037
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> get_partner_design_defaults_with_http_info(partner_id)
|
|
959
1038
|
|
|
960
1039
|
```ruby
|
|
961
1040
|
begin
|
|
962
1041
|
# Read partner-wide design defaults
|
|
963
|
-
data, status_code, headers = api_instance.
|
|
1042
|
+
data, status_code, headers = api_instance.get_partner_design_defaults_with_http_info(partner_id)
|
|
964
1043
|
p status_code # => 2xx
|
|
965
1044
|
p headers # => { ... }
|
|
966
|
-
p data # => <
|
|
1045
|
+
p data # => <DesignDefaultsResponse>
|
|
967
1046
|
rescue ApiSdkRb::ApiError => e
|
|
968
|
-
puts "Error when calling PartnersApi->
|
|
1047
|
+
puts "Error when calling PartnersApi->get_partner_design_defaults_with_http_info: #{e}"
|
|
969
1048
|
end
|
|
970
1049
|
```
|
|
971
1050
|
|
|
@@ -977,7 +1056,7 @@ end
|
|
|
977
1056
|
|
|
978
1057
|
### Return type
|
|
979
1058
|
|
|
980
|
-
[**
|
|
1059
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
981
1060
|
|
|
982
1061
|
### Authorization
|
|
983
1062
|
|
|
@@ -989,9 +1068,9 @@ end
|
|
|
989
1068
|
- **Accept**: application/json
|
|
990
1069
|
|
|
991
1070
|
|
|
992
|
-
##
|
|
1071
|
+
## get_partner_entry_context_signing
|
|
993
1072
|
|
|
994
|
-
> <PartnerEntryContextSigningResponse>
|
|
1073
|
+
> <PartnerEntryContextSigningResponse> get_partner_entry_context_signing(partner_id)
|
|
995
1074
|
|
|
996
1075
|
See how the context of your embeds is signed
|
|
997
1076
|
|
|
@@ -1013,28 +1092,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1013
1092
|
|
|
1014
1093
|
begin
|
|
1015
1094
|
# See how the context of your embeds is signed
|
|
1016
|
-
result = api_instance.
|
|
1095
|
+
result = api_instance.get_partner_entry_context_signing(partner_id)
|
|
1017
1096
|
p result
|
|
1018
1097
|
rescue ApiSdkRb::ApiError => e
|
|
1019
|
-
puts "Error when calling PartnersApi->
|
|
1098
|
+
puts "Error when calling PartnersApi->get_partner_entry_context_signing: #{e}"
|
|
1020
1099
|
end
|
|
1021
1100
|
```
|
|
1022
1101
|
|
|
1023
|
-
#### Using the
|
|
1102
|
+
#### Using the get_partner_entry_context_signing_with_http_info variant
|
|
1024
1103
|
|
|
1025
1104
|
This returns an Array which contains the response data, status code and headers.
|
|
1026
1105
|
|
|
1027
|
-
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)>
|
|
1106
|
+
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)> get_partner_entry_context_signing_with_http_info(partner_id)
|
|
1028
1107
|
|
|
1029
1108
|
```ruby
|
|
1030
1109
|
begin
|
|
1031
1110
|
# See how the context of your embeds is signed
|
|
1032
|
-
data, status_code, headers = api_instance.
|
|
1111
|
+
data, status_code, headers = api_instance.get_partner_entry_context_signing_with_http_info(partner_id)
|
|
1033
1112
|
p status_code # => 2xx
|
|
1034
1113
|
p headers # => { ... }
|
|
1035
1114
|
p data # => <PartnerEntryContextSigningResponse>
|
|
1036
1115
|
rescue ApiSdkRb::ApiError => e
|
|
1037
|
-
puts "Error when calling PartnersApi->
|
|
1116
|
+
puts "Error when calling PartnersApi->get_partner_entry_context_signing_with_http_info: #{e}"
|
|
1038
1117
|
end
|
|
1039
1118
|
```
|
|
1040
1119
|
|
|
@@ -1058,9 +1137,9 @@ end
|
|
|
1058
1137
|
- **Accept**: application/json
|
|
1059
1138
|
|
|
1060
1139
|
|
|
1061
|
-
##
|
|
1140
|
+
## get_partner_notification_settings
|
|
1062
1141
|
|
|
1063
|
-
> <PartnerNotificationSettingsResponse>
|
|
1142
|
+
> <PartnerNotificationSettingsResponse> get_partner_notification_settings(partner_id)
|
|
1064
1143
|
|
|
1065
1144
|
Where your notifications go
|
|
1066
1145
|
|
|
@@ -1082,28 +1161,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1082
1161
|
|
|
1083
1162
|
begin
|
|
1084
1163
|
# Where your notifications go
|
|
1085
|
-
result = api_instance.
|
|
1164
|
+
result = api_instance.get_partner_notification_settings(partner_id)
|
|
1086
1165
|
p result
|
|
1087
1166
|
rescue ApiSdkRb::ApiError => e
|
|
1088
|
-
puts "Error when calling PartnersApi->
|
|
1167
|
+
puts "Error when calling PartnersApi->get_partner_notification_settings: #{e}"
|
|
1089
1168
|
end
|
|
1090
1169
|
```
|
|
1091
1170
|
|
|
1092
|
-
#### Using the
|
|
1171
|
+
#### Using the get_partner_notification_settings_with_http_info variant
|
|
1093
1172
|
|
|
1094
1173
|
This returns an Array which contains the response data, status code and headers.
|
|
1095
1174
|
|
|
1096
|
-
> <Array(<PartnerNotificationSettingsResponse>, Integer, Hash)>
|
|
1175
|
+
> <Array(<PartnerNotificationSettingsResponse>, Integer, Hash)> get_partner_notification_settings_with_http_info(partner_id)
|
|
1097
1176
|
|
|
1098
1177
|
```ruby
|
|
1099
1178
|
begin
|
|
1100
1179
|
# Where your notifications go
|
|
1101
|
-
data, status_code, headers = api_instance.
|
|
1180
|
+
data, status_code, headers = api_instance.get_partner_notification_settings_with_http_info(partner_id)
|
|
1102
1181
|
p status_code # => 2xx
|
|
1103
1182
|
p headers # => { ... }
|
|
1104
1183
|
p data # => <PartnerNotificationSettingsResponse>
|
|
1105
1184
|
rescue ApiSdkRb::ApiError => e
|
|
1106
|
-
puts "Error when calling PartnersApi->
|
|
1185
|
+
puts "Error when calling PartnersApi->get_partner_notification_settings_with_http_info: #{e}"
|
|
1107
1186
|
end
|
|
1108
1187
|
```
|
|
1109
1188
|
|
|
@@ -1127,9 +1206,9 @@ end
|
|
|
1127
1206
|
- **Accept**: application/json
|
|
1128
1207
|
|
|
1129
1208
|
|
|
1130
|
-
##
|
|
1209
|
+
## get_partner_storage_destination
|
|
1131
1210
|
|
|
1132
|
-
> <PartnerStorageDestinationResponse>
|
|
1211
|
+
> <PartnerStorageDestinationResponse> get_partner_storage_destination(partner_id)
|
|
1133
1212
|
|
|
1134
1213
|
Get where a partner's uploaded files are stored
|
|
1135
1214
|
|
|
@@ -1151,28 +1230,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1151
1230
|
|
|
1152
1231
|
begin
|
|
1153
1232
|
# Get where a partner's uploaded files are stored
|
|
1154
|
-
result = api_instance.
|
|
1233
|
+
result = api_instance.get_partner_storage_destination(partner_id)
|
|
1155
1234
|
p result
|
|
1156
1235
|
rescue ApiSdkRb::ApiError => e
|
|
1157
|
-
puts "Error when calling PartnersApi->
|
|
1236
|
+
puts "Error when calling PartnersApi->get_partner_storage_destination: #{e}"
|
|
1158
1237
|
end
|
|
1159
1238
|
```
|
|
1160
1239
|
|
|
1161
|
-
#### Using the
|
|
1240
|
+
#### Using the get_partner_storage_destination_with_http_info variant
|
|
1162
1241
|
|
|
1163
1242
|
This returns an Array which contains the response data, status code and headers.
|
|
1164
1243
|
|
|
1165
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
1244
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> get_partner_storage_destination_with_http_info(partner_id)
|
|
1166
1245
|
|
|
1167
1246
|
```ruby
|
|
1168
1247
|
begin
|
|
1169
1248
|
# Get where a partner's uploaded files are stored
|
|
1170
|
-
data, status_code, headers = api_instance.
|
|
1249
|
+
data, status_code, headers = api_instance.get_partner_storage_destination_with_http_info(partner_id)
|
|
1171
1250
|
p status_code # => 2xx
|
|
1172
1251
|
p headers # => { ... }
|
|
1173
1252
|
p data # => <PartnerStorageDestinationResponse>
|
|
1174
1253
|
rescue ApiSdkRb::ApiError => e
|
|
1175
|
-
puts "Error when calling PartnersApi->
|
|
1254
|
+
puts "Error when calling PartnersApi->get_partner_storage_destination_with_http_info: #{e}"
|
|
1176
1255
|
end
|
|
1177
1256
|
```
|
|
1178
1257
|
|
|
@@ -1196,13 +1275,13 @@ end
|
|
|
1196
1275
|
- **Accept**: application/json
|
|
1197
1276
|
|
|
1198
1277
|
|
|
1199
|
-
##
|
|
1278
|
+
## get_partner_storage_usage
|
|
1200
1279
|
|
|
1201
|
-
> <PartnerStorageUsageResponse>
|
|
1280
|
+
> <PartnerStorageUsageResponse> get_partner_storage_usage(partner_id, opts)
|
|
1202
1281
|
|
|
1203
1282
|
What a partner's customers store
|
|
1204
1283
|
|
|
1205
|
-
Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic's storage and how much in your own storage destination (`setPartnerStorageDestination`). Use it to see which customers store the most, or to charge them for it. A file is counted for a managed user when it was filed under that user: by naming `managed_user_id` or `managed_user_external_id` when you upload it (`
|
|
1284
|
+
Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic's storage and how much in your own storage destination (`setPartnerStorageDestination`). Use it to see which customers store the most, or to charge them for it. A file is counted for a managed user when it was filed under that user: by naming `managed_user_id` or `managed_user_external_id` when you upload it (`uploadFile`, or the metadata of a resumable upload), or because it was uploaded through that user's editor session, which files everything under its user. The files that are not filed under anyone (your own, and the ones uploaded without naming a managed user) are the row whose `managedUserId` is null. Deleted files are not counted. To list the files of one managed user, use the `managed_user_id` filter of `listUploads`. The answer is counted when you ask, so it is always current. The groups are ordered by size, the heaviest first, and `page.hasMore` says whether more follow. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
1206
1285
|
|
|
1207
1286
|
### Examples
|
|
1208
1287
|
|
|
@@ -1224,28 +1303,28 @@ opts = {
|
|
|
1224
1303
|
|
|
1225
1304
|
begin
|
|
1226
1305
|
# What a partner's customers store
|
|
1227
|
-
result = api_instance.
|
|
1306
|
+
result = api_instance.get_partner_storage_usage(partner_id, opts)
|
|
1228
1307
|
p result
|
|
1229
1308
|
rescue ApiSdkRb::ApiError => e
|
|
1230
|
-
puts "Error when calling PartnersApi->
|
|
1309
|
+
puts "Error when calling PartnersApi->get_partner_storage_usage: #{e}"
|
|
1231
1310
|
end
|
|
1232
1311
|
```
|
|
1233
1312
|
|
|
1234
|
-
#### Using the
|
|
1313
|
+
#### Using the get_partner_storage_usage_with_http_info variant
|
|
1235
1314
|
|
|
1236
1315
|
This returns an Array which contains the response data, status code and headers.
|
|
1237
1316
|
|
|
1238
|
-
> <Array(<PartnerStorageUsageResponse>, Integer, Hash)>
|
|
1317
|
+
> <Array(<PartnerStorageUsageResponse>, Integer, Hash)> get_partner_storage_usage_with_http_info(partner_id, opts)
|
|
1239
1318
|
|
|
1240
1319
|
```ruby
|
|
1241
1320
|
begin
|
|
1242
1321
|
# What a partner's customers store
|
|
1243
|
-
data, status_code, headers = api_instance.
|
|
1322
|
+
data, status_code, headers = api_instance.get_partner_storage_usage_with_http_info(partner_id, opts)
|
|
1244
1323
|
p status_code # => 2xx
|
|
1245
1324
|
p headers # => { ... }
|
|
1246
1325
|
p data # => <PartnerStorageUsageResponse>
|
|
1247
1326
|
rescue ApiSdkRb::ApiError => e
|
|
1248
|
-
puts "Error when calling PartnersApi->
|
|
1327
|
+
puts "Error when calling PartnersApi->get_partner_storage_usage_with_http_info: #{e}"
|
|
1249
1328
|
end
|
|
1250
1329
|
```
|
|
1251
1330
|
|
|
@@ -1271,9 +1350,9 @@ end
|
|
|
1271
1350
|
- **Accept**: application/json
|
|
1272
1351
|
|
|
1273
1352
|
|
|
1274
|
-
##
|
|
1353
|
+
## list_partner_notification_deliveries
|
|
1275
1354
|
|
|
1276
|
-
> <PartnerNotificationDeliveryLogResponse>
|
|
1355
|
+
> <PartnerNotificationDeliveryLogResponse> list_partner_notification_deliveries(partner_id, opts)
|
|
1277
1356
|
|
|
1278
1357
|
How your notifications reached you
|
|
1279
1358
|
|
|
@@ -1298,28 +1377,28 @@ opts = {
|
|
|
1298
1377
|
|
|
1299
1378
|
begin
|
|
1300
1379
|
# How your notifications reached you
|
|
1301
|
-
result = api_instance.
|
|
1380
|
+
result = api_instance.list_partner_notification_deliveries(partner_id, opts)
|
|
1302
1381
|
p result
|
|
1303
1382
|
rescue ApiSdkRb::ApiError => e
|
|
1304
|
-
puts "Error when calling PartnersApi->
|
|
1383
|
+
puts "Error when calling PartnersApi->list_partner_notification_deliveries: #{e}"
|
|
1305
1384
|
end
|
|
1306
1385
|
```
|
|
1307
1386
|
|
|
1308
|
-
#### Using the
|
|
1387
|
+
#### Using the list_partner_notification_deliveries_with_http_info variant
|
|
1309
1388
|
|
|
1310
1389
|
This returns an Array which contains the response data, status code and headers.
|
|
1311
1390
|
|
|
1312
|
-
> <Array(<PartnerNotificationDeliveryLogResponse>, Integer, Hash)>
|
|
1391
|
+
> <Array(<PartnerNotificationDeliveryLogResponse>, Integer, Hash)> list_partner_notification_deliveries_with_http_info(partner_id, opts)
|
|
1313
1392
|
|
|
1314
1393
|
```ruby
|
|
1315
1394
|
begin
|
|
1316
1395
|
# How your notifications reached you
|
|
1317
|
-
data, status_code, headers = api_instance.
|
|
1396
|
+
data, status_code, headers = api_instance.list_partner_notification_deliveries_with_http_info(partner_id, opts)
|
|
1318
1397
|
p status_code # => 2xx
|
|
1319
1398
|
p headers # => { ... }
|
|
1320
1399
|
p data # => <PartnerNotificationDeliveryLogResponse>
|
|
1321
1400
|
rescue ApiSdkRb::ApiError => e
|
|
1322
|
-
puts "Error when calling PartnersApi->
|
|
1401
|
+
puts "Error when calling PartnersApi->list_partner_notification_deliveries_with_http_info: #{e}"
|
|
1323
1402
|
end
|
|
1324
1403
|
```
|
|
1325
1404
|
|
|
@@ -1344,9 +1423,9 @@ end
|
|
|
1344
1423
|
- **Accept**: application/json
|
|
1345
1424
|
|
|
1346
1425
|
|
|
1347
|
-
##
|
|
1426
|
+
## list_partner_notifications
|
|
1348
1427
|
|
|
1349
|
-
> <PartnerNotificationPageResponse>
|
|
1428
|
+
> <PartnerNotificationPageResponse> list_partner_notifications(partner_id, opts)
|
|
1350
1429
|
|
|
1351
1430
|
What your partner account was told
|
|
1352
1431
|
|
|
@@ -1372,28 +1451,28 @@ opts = {
|
|
|
1372
1451
|
|
|
1373
1452
|
begin
|
|
1374
1453
|
# What your partner account was told
|
|
1375
|
-
result = api_instance.
|
|
1454
|
+
result = api_instance.list_partner_notifications(partner_id, opts)
|
|
1376
1455
|
p result
|
|
1377
1456
|
rescue ApiSdkRb::ApiError => e
|
|
1378
|
-
puts "Error when calling PartnersApi->
|
|
1457
|
+
puts "Error when calling PartnersApi->list_partner_notifications: #{e}"
|
|
1379
1458
|
end
|
|
1380
1459
|
```
|
|
1381
1460
|
|
|
1382
|
-
#### Using the
|
|
1461
|
+
#### Using the list_partner_notifications_with_http_info variant
|
|
1383
1462
|
|
|
1384
1463
|
This returns an Array which contains the response data, status code and headers.
|
|
1385
1464
|
|
|
1386
|
-
> <Array(<PartnerNotificationPageResponse>, Integer, Hash)>
|
|
1465
|
+
> <Array(<PartnerNotificationPageResponse>, Integer, Hash)> list_partner_notifications_with_http_info(partner_id, opts)
|
|
1387
1466
|
|
|
1388
1467
|
```ruby
|
|
1389
1468
|
begin
|
|
1390
1469
|
# What your partner account was told
|
|
1391
|
-
data, status_code, headers = api_instance.
|
|
1470
|
+
data, status_code, headers = api_instance.list_partner_notifications_with_http_info(partner_id, opts)
|
|
1392
1471
|
p status_code # => 2xx
|
|
1393
1472
|
p headers # => { ... }
|
|
1394
1473
|
p data # => <PartnerNotificationPageResponse>
|
|
1395
1474
|
rescue ApiSdkRb::ApiError => e
|
|
1396
|
-
puts "Error when calling PartnersApi->
|
|
1475
|
+
puts "Error when calling PartnersApi->list_partner_notifications_with_http_info: #{e}"
|
|
1397
1476
|
end
|
|
1398
1477
|
```
|
|
1399
1478
|
|
|
@@ -1419,9 +1498,9 @@ end
|
|
|
1419
1498
|
- **Accept**: application/json
|
|
1420
1499
|
|
|
1421
1500
|
|
|
1422
|
-
##
|
|
1501
|
+
## list_partner_presets
|
|
1423
1502
|
|
|
1424
|
-
> <ListPartnerPresets200Response>
|
|
1503
|
+
> <ListPartnerPresets200Response> list_partner_presets(partner_id)
|
|
1425
1504
|
|
|
1426
1505
|
List the widgets a partner offers as presets
|
|
1427
1506
|
|
|
@@ -1443,28 +1522,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1443
1522
|
|
|
1444
1523
|
begin
|
|
1445
1524
|
# List the widgets a partner offers as presets
|
|
1446
|
-
result = api_instance.
|
|
1525
|
+
result = api_instance.list_partner_presets(partner_id)
|
|
1447
1526
|
p result
|
|
1448
1527
|
rescue ApiSdkRb::ApiError => e
|
|
1449
|
-
puts "Error when calling PartnersApi->
|
|
1528
|
+
puts "Error when calling PartnersApi->list_partner_presets: #{e}"
|
|
1450
1529
|
end
|
|
1451
1530
|
```
|
|
1452
1531
|
|
|
1453
|
-
#### Using the
|
|
1532
|
+
#### Using the list_partner_presets_with_http_info variant
|
|
1454
1533
|
|
|
1455
1534
|
This returns an Array which contains the response data, status code and headers.
|
|
1456
1535
|
|
|
1457
|
-
> <Array(<ListPartnerPresets200Response>, Integer, Hash)>
|
|
1536
|
+
> <Array(<ListPartnerPresets200Response>, Integer, Hash)> list_partner_presets_with_http_info(partner_id)
|
|
1458
1537
|
|
|
1459
1538
|
```ruby
|
|
1460
1539
|
begin
|
|
1461
1540
|
# List the widgets a partner offers as presets
|
|
1462
|
-
data, status_code, headers = api_instance.
|
|
1541
|
+
data, status_code, headers = api_instance.list_partner_presets_with_http_info(partner_id)
|
|
1463
1542
|
p status_code # => 2xx
|
|
1464
1543
|
p headers # => { ... }
|
|
1465
1544
|
p data # => <ListPartnerPresets200Response>
|
|
1466
1545
|
rescue ApiSdkRb::ApiError => e
|
|
1467
|
-
puts "Error when calling PartnersApi->
|
|
1546
|
+
puts "Error when calling PartnersApi->list_partner_presets_with_http_info: #{e}"
|
|
1468
1547
|
end
|
|
1469
1548
|
```
|
|
1470
1549
|
|
|
@@ -1488,9 +1567,78 @@ end
|
|
|
1488
1567
|
- **Accept**: application/json
|
|
1489
1568
|
|
|
1490
1569
|
|
|
1491
|
-
##
|
|
1570
|
+
## list_partner_workflow_presets
|
|
1571
|
+
|
|
1572
|
+
> <ListPartnerWorkflowPresets200Response> list_partner_workflow_presets(partner_id)
|
|
1573
|
+
|
|
1574
|
+
List the workflows a partner offers as places to start
|
|
1492
1575
|
|
|
1493
|
-
|
|
1576
|
+
The partner's starting points, ordered by `position` and then by `key`: the published workflows it offers its managed users when they make a new workflow. Each says whether people can start from it now and, when they cannot, why. The list is the same for every managed user, and a managed user is shown only what is available. A starting point is one of the partner account's own published workflows, built from compositions the account made for itself (not for a customer or a team) and from widgets the partner already offers as presets (`setPartnerPreset`), and it uses at most 10 widgets. A partner offers up to 50. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
|
|
1577
|
+
|
|
1578
|
+
### Examples
|
|
1579
|
+
|
|
1580
|
+
```ruby
|
|
1581
|
+
require 'time'
|
|
1582
|
+
require 'api-sdk-rb'
|
|
1583
|
+
# setup authorization
|
|
1584
|
+
ApiSdkRb.configure do |config|
|
|
1585
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1586
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1587
|
+
end
|
|
1588
|
+
|
|
1589
|
+
api_instance = ApiSdkRb::PartnersApi.new
|
|
1590
|
+
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting points to list
|
|
1591
|
+
|
|
1592
|
+
begin
|
|
1593
|
+
# List the workflows a partner offers as places to start
|
|
1594
|
+
result = api_instance.list_partner_workflow_presets(partner_id)
|
|
1595
|
+
p result
|
|
1596
|
+
rescue ApiSdkRb::ApiError => e
|
|
1597
|
+
puts "Error when calling PartnersApi->list_partner_workflow_presets: #{e}"
|
|
1598
|
+
end
|
|
1599
|
+
```
|
|
1600
|
+
|
|
1601
|
+
#### Using the list_partner_workflow_presets_with_http_info variant
|
|
1602
|
+
|
|
1603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1604
|
+
|
|
1605
|
+
> <Array(<ListPartnerWorkflowPresets200Response>, Integer, Hash)> list_partner_workflow_presets_with_http_info(partner_id)
|
|
1606
|
+
|
|
1607
|
+
```ruby
|
|
1608
|
+
begin
|
|
1609
|
+
# List the workflows a partner offers as places to start
|
|
1610
|
+
data, status_code, headers = api_instance.list_partner_workflow_presets_with_http_info(partner_id)
|
|
1611
|
+
p status_code # => 2xx
|
|
1612
|
+
p headers # => { ... }
|
|
1613
|
+
p data # => <ListPartnerWorkflowPresets200Response>
|
|
1614
|
+
rescue ApiSdkRb::ApiError => e
|
|
1615
|
+
puts "Error when calling PartnersApi->list_partner_workflow_presets_with_http_info: #{e}"
|
|
1616
|
+
end
|
|
1617
|
+
```
|
|
1618
|
+
|
|
1619
|
+
### Parameters
|
|
1620
|
+
|
|
1621
|
+
| Name | Type | Description | Notes |
|
|
1622
|
+
| ---- | ---- | ----------- | ----- |
|
|
1623
|
+
| **partner_id** | **String** | The partner whose starting points to list | |
|
|
1624
|
+
|
|
1625
|
+
### Return type
|
|
1626
|
+
|
|
1627
|
+
[**ListPartnerWorkflowPresets200Response**](ListPartnerWorkflowPresets200Response.md)
|
|
1628
|
+
|
|
1629
|
+
### Authorization
|
|
1630
|
+
|
|
1631
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1632
|
+
|
|
1633
|
+
### HTTP request headers
|
|
1634
|
+
|
|
1635
|
+
- **Content-Type**: Not defined
|
|
1636
|
+
- **Accept**: application/json
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
## remove_partner_adapter_connection
|
|
1640
|
+
|
|
1641
|
+
> <AdapterConnectionRemovalResponse> remove_partner_adapter_connection(partner_id, adapter_id, credential_key)
|
|
1494
1642
|
|
|
1495
1643
|
Remove an adapter key from a partner
|
|
1496
1644
|
|
|
@@ -1514,28 +1662,28 @@ credential_key = 'credential_key_example' # String | The key's name within the a
|
|
|
1514
1662
|
|
|
1515
1663
|
begin
|
|
1516
1664
|
# Remove an adapter key from a partner
|
|
1517
|
-
result = api_instance.
|
|
1665
|
+
result = api_instance.remove_partner_adapter_connection(partner_id, adapter_id, credential_key)
|
|
1518
1666
|
p result
|
|
1519
1667
|
rescue ApiSdkRb::ApiError => e
|
|
1520
|
-
puts "Error when calling PartnersApi->
|
|
1668
|
+
puts "Error when calling PartnersApi->remove_partner_adapter_connection: #{e}"
|
|
1521
1669
|
end
|
|
1522
1670
|
```
|
|
1523
1671
|
|
|
1524
|
-
#### Using the
|
|
1672
|
+
#### Using the remove_partner_adapter_connection_with_http_info variant
|
|
1525
1673
|
|
|
1526
1674
|
This returns an Array which contains the response data, status code and headers.
|
|
1527
1675
|
|
|
1528
|
-
> <Array(<
|
|
1676
|
+
> <Array(<AdapterConnectionRemovalResponse>, Integer, Hash)> remove_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key)
|
|
1529
1677
|
|
|
1530
1678
|
```ruby
|
|
1531
1679
|
begin
|
|
1532
1680
|
# Remove an adapter key from a partner
|
|
1533
|
-
data, status_code, headers = api_instance.
|
|
1681
|
+
data, status_code, headers = api_instance.remove_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key)
|
|
1534
1682
|
p status_code # => 2xx
|
|
1535
1683
|
p headers # => { ... }
|
|
1536
|
-
p data # => <
|
|
1684
|
+
p data # => <AdapterConnectionRemovalResponse>
|
|
1537
1685
|
rescue ApiSdkRb::ApiError => e
|
|
1538
|
-
puts "Error when calling PartnersApi->
|
|
1686
|
+
puts "Error when calling PartnersApi->remove_partner_adapter_connection_with_http_info: #{e}"
|
|
1539
1687
|
end
|
|
1540
1688
|
```
|
|
1541
1689
|
|
|
@@ -1549,7 +1697,7 @@ end
|
|
|
1549
1697
|
|
|
1550
1698
|
### Return type
|
|
1551
1699
|
|
|
1552
|
-
[**
|
|
1700
|
+
[**AdapterConnectionRemovalResponse**](AdapterConnectionRemovalResponse.md)
|
|
1553
1701
|
|
|
1554
1702
|
### Authorization
|
|
1555
1703
|
|
|
@@ -1561,9 +1709,9 @@ end
|
|
|
1561
1709
|
- **Accept**: application/json
|
|
1562
1710
|
|
|
1563
1711
|
|
|
1564
|
-
##
|
|
1712
|
+
## remove_partner_data_database
|
|
1565
1713
|
|
|
1566
|
-
> <PartnerDataDatabaseRemovalResponse>
|
|
1714
|
+
> <PartnerDataDatabaseRemovalResponse> remove_partner_data_database(partner_id)
|
|
1567
1715
|
|
|
1568
1716
|
Stop keeping the data of a partner's compositions in its own database
|
|
1569
1717
|
|
|
@@ -1585,28 +1733,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1585
1733
|
|
|
1586
1734
|
begin
|
|
1587
1735
|
# Stop keeping the data of a partner's compositions in its own database
|
|
1588
|
-
result = api_instance.
|
|
1736
|
+
result = api_instance.remove_partner_data_database(partner_id)
|
|
1589
1737
|
p result
|
|
1590
1738
|
rescue ApiSdkRb::ApiError => e
|
|
1591
|
-
puts "Error when calling PartnersApi->
|
|
1739
|
+
puts "Error when calling PartnersApi->remove_partner_data_database: #{e}"
|
|
1592
1740
|
end
|
|
1593
1741
|
```
|
|
1594
1742
|
|
|
1595
|
-
#### Using the
|
|
1743
|
+
#### Using the remove_partner_data_database_with_http_info variant
|
|
1596
1744
|
|
|
1597
1745
|
This returns an Array which contains the response data, status code and headers.
|
|
1598
1746
|
|
|
1599
|
-
> <Array(<PartnerDataDatabaseRemovalResponse>, Integer, Hash)>
|
|
1747
|
+
> <Array(<PartnerDataDatabaseRemovalResponse>, Integer, Hash)> remove_partner_data_database_with_http_info(partner_id)
|
|
1600
1748
|
|
|
1601
1749
|
```ruby
|
|
1602
1750
|
begin
|
|
1603
1751
|
# Stop keeping the data of a partner's compositions in its own database
|
|
1604
|
-
data, status_code, headers = api_instance.
|
|
1752
|
+
data, status_code, headers = api_instance.remove_partner_data_database_with_http_info(partner_id)
|
|
1605
1753
|
p status_code # => 2xx
|
|
1606
1754
|
p headers # => { ... }
|
|
1607
1755
|
p data # => <PartnerDataDatabaseRemovalResponse>
|
|
1608
1756
|
rescue ApiSdkRb::ApiError => e
|
|
1609
|
-
puts "Error when calling PartnersApi->
|
|
1757
|
+
puts "Error when calling PartnersApi->remove_partner_data_database_with_http_info: #{e}"
|
|
1610
1758
|
end
|
|
1611
1759
|
```
|
|
1612
1760
|
|
|
@@ -1630,9 +1778,9 @@ end
|
|
|
1630
1778
|
- **Accept**: application/json
|
|
1631
1779
|
|
|
1632
1780
|
|
|
1633
|
-
##
|
|
1781
|
+
## remove_partner_preset
|
|
1634
1782
|
|
|
1635
|
-
> <PartnerPresetRemovalResponse>
|
|
1783
|
+
> <PartnerPresetRemovalResponse> remove_partner_preset(partner_id, key)
|
|
1636
1784
|
|
|
1637
1785
|
Take a widget off the partner's presets
|
|
1638
1786
|
|
|
@@ -1655,28 +1803,28 @@ key = 'key_example' # String | The key of the preset to remove
|
|
|
1655
1803
|
|
|
1656
1804
|
begin
|
|
1657
1805
|
# Take a widget off the partner's presets
|
|
1658
|
-
result = api_instance.
|
|
1806
|
+
result = api_instance.remove_partner_preset(partner_id, key)
|
|
1659
1807
|
p result
|
|
1660
1808
|
rescue ApiSdkRb::ApiError => e
|
|
1661
|
-
puts "Error when calling PartnersApi->
|
|
1809
|
+
puts "Error when calling PartnersApi->remove_partner_preset: #{e}"
|
|
1662
1810
|
end
|
|
1663
1811
|
```
|
|
1664
1812
|
|
|
1665
|
-
#### Using the
|
|
1813
|
+
#### Using the remove_partner_preset_with_http_info variant
|
|
1666
1814
|
|
|
1667
1815
|
This returns an Array which contains the response data, status code and headers.
|
|
1668
1816
|
|
|
1669
|
-
> <Array(<PartnerPresetRemovalResponse>, Integer, Hash)>
|
|
1817
|
+
> <Array(<PartnerPresetRemovalResponse>, Integer, Hash)> remove_partner_preset_with_http_info(partner_id, key)
|
|
1670
1818
|
|
|
1671
1819
|
```ruby
|
|
1672
1820
|
begin
|
|
1673
1821
|
# Take a widget off the partner's presets
|
|
1674
|
-
data, status_code, headers = api_instance.
|
|
1822
|
+
data, status_code, headers = api_instance.remove_partner_preset_with_http_info(partner_id, key)
|
|
1675
1823
|
p status_code # => 2xx
|
|
1676
1824
|
p headers # => { ... }
|
|
1677
1825
|
p data # => <PartnerPresetRemovalResponse>
|
|
1678
1826
|
rescue ApiSdkRb::ApiError => e
|
|
1679
|
-
puts "Error when calling PartnersApi->
|
|
1827
|
+
puts "Error when calling PartnersApi->remove_partner_preset_with_http_info: #{e}"
|
|
1680
1828
|
end
|
|
1681
1829
|
```
|
|
1682
1830
|
|
|
@@ -1701,9 +1849,9 @@ end
|
|
|
1701
1849
|
- **Accept**: application/json
|
|
1702
1850
|
|
|
1703
1851
|
|
|
1704
|
-
##
|
|
1852
|
+
## remove_partner_storage_destination
|
|
1705
1853
|
|
|
1706
|
-
> <PartnerStorageRemovalResponse>
|
|
1854
|
+
> <PartnerStorageRemovalResponse> remove_partner_storage_destination(partner_id)
|
|
1707
1855
|
|
|
1708
1856
|
Stop storing a partner's uploaded files in its own bucket
|
|
1709
1857
|
|
|
@@ -1725,28 +1873,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1725
1873
|
|
|
1726
1874
|
begin
|
|
1727
1875
|
# Stop storing a partner's uploaded files in its own bucket
|
|
1728
|
-
result = api_instance.
|
|
1876
|
+
result = api_instance.remove_partner_storage_destination(partner_id)
|
|
1729
1877
|
p result
|
|
1730
1878
|
rescue ApiSdkRb::ApiError => e
|
|
1731
|
-
puts "Error when calling PartnersApi->
|
|
1879
|
+
puts "Error when calling PartnersApi->remove_partner_storage_destination: #{e}"
|
|
1732
1880
|
end
|
|
1733
1881
|
```
|
|
1734
1882
|
|
|
1735
|
-
#### Using the
|
|
1883
|
+
#### Using the remove_partner_storage_destination_with_http_info variant
|
|
1736
1884
|
|
|
1737
1885
|
This returns an Array which contains the response data, status code and headers.
|
|
1738
1886
|
|
|
1739
|
-
> <Array(<PartnerStorageRemovalResponse>, Integer, Hash)>
|
|
1887
|
+
> <Array(<PartnerStorageRemovalResponse>, Integer, Hash)> remove_partner_storage_destination_with_http_info(partner_id)
|
|
1740
1888
|
|
|
1741
1889
|
```ruby
|
|
1742
1890
|
begin
|
|
1743
1891
|
# Stop storing a partner's uploaded files in its own bucket
|
|
1744
|
-
data, status_code, headers = api_instance.
|
|
1892
|
+
data, status_code, headers = api_instance.remove_partner_storage_destination_with_http_info(partner_id)
|
|
1745
1893
|
p status_code # => 2xx
|
|
1746
1894
|
p headers # => { ... }
|
|
1747
1895
|
p data # => <PartnerStorageRemovalResponse>
|
|
1748
1896
|
rescue ApiSdkRb::ApiError => e
|
|
1749
|
-
puts "Error when calling PartnersApi->
|
|
1897
|
+
puts "Error when calling PartnersApi->remove_partner_storage_destination_with_http_info: #{e}"
|
|
1750
1898
|
end
|
|
1751
1899
|
```
|
|
1752
1900
|
|
|
@@ -1770,9 +1918,80 @@ end
|
|
|
1770
1918
|
- **Accept**: application/json
|
|
1771
1919
|
|
|
1772
1920
|
|
|
1773
|
-
##
|
|
1921
|
+
## remove_partner_workflow_preset
|
|
1922
|
+
|
|
1923
|
+
> <RemovePartnerWorkflowPreset200Response> remove_partner_workflow_preset(partner_id, key)
|
|
1924
|
+
|
|
1925
|
+
Stop offering a workflow as a place to start
|
|
1926
|
+
|
|
1927
|
+
Removes the starting point under `key`. The workflow itself is not touched, and neither are the workflows people already started from it. Removing a starting point the partner does not offer is not an error: the answer is `removed: false`.
|
|
1928
|
+
|
|
1929
|
+
### Examples
|
|
1930
|
+
|
|
1931
|
+
```ruby
|
|
1932
|
+
require 'time'
|
|
1933
|
+
require 'api-sdk-rb'
|
|
1934
|
+
# setup authorization
|
|
1935
|
+
ApiSdkRb.configure do |config|
|
|
1936
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1937
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1938
|
+
end
|
|
1939
|
+
|
|
1940
|
+
api_instance = ApiSdkRb::PartnersApi.new
|
|
1941
|
+
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting point to remove
|
|
1942
|
+
key = 'key_example' # String | The key of the starting point to remove
|
|
1943
|
+
|
|
1944
|
+
begin
|
|
1945
|
+
# Stop offering a workflow as a place to start
|
|
1946
|
+
result = api_instance.remove_partner_workflow_preset(partner_id, key)
|
|
1947
|
+
p result
|
|
1948
|
+
rescue ApiSdkRb::ApiError => e
|
|
1949
|
+
puts "Error when calling PartnersApi->remove_partner_workflow_preset: #{e}"
|
|
1950
|
+
end
|
|
1951
|
+
```
|
|
1952
|
+
|
|
1953
|
+
#### Using the remove_partner_workflow_preset_with_http_info variant
|
|
1954
|
+
|
|
1955
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1956
|
+
|
|
1957
|
+
> <Array(<RemovePartnerWorkflowPreset200Response>, Integer, Hash)> remove_partner_workflow_preset_with_http_info(partner_id, key)
|
|
1958
|
+
|
|
1959
|
+
```ruby
|
|
1960
|
+
begin
|
|
1961
|
+
# Stop offering a workflow as a place to start
|
|
1962
|
+
data, status_code, headers = api_instance.remove_partner_workflow_preset_with_http_info(partner_id, key)
|
|
1963
|
+
p status_code # => 2xx
|
|
1964
|
+
p headers # => { ... }
|
|
1965
|
+
p data # => <RemovePartnerWorkflowPreset200Response>
|
|
1966
|
+
rescue ApiSdkRb::ApiError => e
|
|
1967
|
+
puts "Error when calling PartnersApi->remove_partner_workflow_preset_with_http_info: #{e}"
|
|
1968
|
+
end
|
|
1969
|
+
```
|
|
1970
|
+
|
|
1971
|
+
### Parameters
|
|
1972
|
+
|
|
1973
|
+
| Name | Type | Description | Notes |
|
|
1974
|
+
| ---- | ---- | ----------- | ----- |
|
|
1975
|
+
| **partner_id** | **String** | The partner whose starting point to remove | |
|
|
1976
|
+
| **key** | **String** | The key of the starting point to remove | |
|
|
1977
|
+
|
|
1978
|
+
### Return type
|
|
1979
|
+
|
|
1980
|
+
[**RemovePartnerWorkflowPreset200Response**](RemovePartnerWorkflowPreset200Response.md)
|
|
1981
|
+
|
|
1982
|
+
### Authorization
|
|
1983
|
+
|
|
1984
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1985
|
+
|
|
1986
|
+
### HTTP request headers
|
|
1987
|
+
|
|
1988
|
+
- **Content-Type**: Not defined
|
|
1989
|
+
- **Accept**: application/json
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
## replay_partner_notification_delivery
|
|
1774
1993
|
|
|
1775
|
-
> <PartnerNotificationDeliveryResponse>
|
|
1994
|
+
> <PartnerNotificationDeliveryResponse> replay_partner_notification_delivery(partner_id, delivery_id, idempotency_key)
|
|
1776
1995
|
|
|
1777
1996
|
Send a webhook delivery again
|
|
1778
1997
|
|
|
@@ -1796,28 +2015,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
1796
2015
|
|
|
1797
2016
|
begin
|
|
1798
2017
|
# Send a webhook delivery again
|
|
1799
|
-
result = api_instance.
|
|
2018
|
+
result = api_instance.replay_partner_notification_delivery(partner_id, delivery_id, idempotency_key)
|
|
1800
2019
|
p result
|
|
1801
2020
|
rescue ApiSdkRb::ApiError => e
|
|
1802
|
-
puts "Error when calling PartnersApi->
|
|
2021
|
+
puts "Error when calling PartnersApi->replay_partner_notification_delivery: #{e}"
|
|
1803
2022
|
end
|
|
1804
2023
|
```
|
|
1805
2024
|
|
|
1806
|
-
#### Using the
|
|
2025
|
+
#### Using the replay_partner_notification_delivery_with_http_info variant
|
|
1807
2026
|
|
|
1808
2027
|
This returns an Array which contains the response data, status code and headers.
|
|
1809
2028
|
|
|
1810
|
-
> <Array(<PartnerNotificationDeliveryResponse>, Integer, Hash)>
|
|
2029
|
+
> <Array(<PartnerNotificationDeliveryResponse>, Integer, Hash)> replay_partner_notification_delivery_with_http_info(partner_id, delivery_id, idempotency_key)
|
|
1811
2030
|
|
|
1812
2031
|
```ruby
|
|
1813
2032
|
begin
|
|
1814
2033
|
# Send a webhook delivery again
|
|
1815
|
-
data, status_code, headers = api_instance.
|
|
2034
|
+
data, status_code, headers = api_instance.replay_partner_notification_delivery_with_http_info(partner_id, delivery_id, idempotency_key)
|
|
1816
2035
|
p status_code # => 2xx
|
|
1817
2036
|
p headers # => { ... }
|
|
1818
2037
|
p data # => <PartnerNotificationDeliveryResponse>
|
|
1819
2038
|
rescue ApiSdkRb::ApiError => e
|
|
1820
|
-
puts "Error when calling PartnersApi->
|
|
2039
|
+
puts "Error when calling PartnersApi->replay_partner_notification_delivery_with_http_info: #{e}"
|
|
1821
2040
|
end
|
|
1822
2041
|
```
|
|
1823
2042
|
|
|
@@ -1843,9 +2062,9 @@ end
|
|
|
1843
2062
|
- **Accept**: application/json
|
|
1844
2063
|
|
|
1845
2064
|
|
|
1846
|
-
##
|
|
2065
|
+
## rotate_partner_entry_context_secret
|
|
1847
2066
|
|
|
1848
|
-
> <PartnerEntryContextSecretResponse>
|
|
2067
|
+
> <PartnerEntryContextSecretResponse> rotate_partner_entry_context_secret(partner_id, idempotency_key)
|
|
1849
2068
|
|
|
1850
2069
|
Make a secret to sign the context of your embeds
|
|
1851
2070
|
|
|
@@ -1868,28 +2087,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
1868
2087
|
|
|
1869
2088
|
begin
|
|
1870
2089
|
# Make a secret to sign the context of your embeds
|
|
1871
|
-
result = api_instance.
|
|
2090
|
+
result = api_instance.rotate_partner_entry_context_secret(partner_id, idempotency_key)
|
|
1872
2091
|
p result
|
|
1873
2092
|
rescue ApiSdkRb::ApiError => e
|
|
1874
|
-
puts "Error when calling PartnersApi->
|
|
2093
|
+
puts "Error when calling PartnersApi->rotate_partner_entry_context_secret: #{e}"
|
|
1875
2094
|
end
|
|
1876
2095
|
```
|
|
1877
2096
|
|
|
1878
|
-
#### Using the
|
|
2097
|
+
#### Using the rotate_partner_entry_context_secret_with_http_info variant
|
|
1879
2098
|
|
|
1880
2099
|
This returns an Array which contains the response data, status code and headers.
|
|
1881
2100
|
|
|
1882
|
-
> <Array(<PartnerEntryContextSecretResponse>, Integer, Hash)>
|
|
2101
|
+
> <Array(<PartnerEntryContextSecretResponse>, Integer, Hash)> rotate_partner_entry_context_secret_with_http_info(partner_id, idempotency_key)
|
|
1883
2102
|
|
|
1884
2103
|
```ruby
|
|
1885
2104
|
begin
|
|
1886
2105
|
# Make a secret to sign the context of your embeds
|
|
1887
|
-
data, status_code, headers = api_instance.
|
|
2106
|
+
data, status_code, headers = api_instance.rotate_partner_entry_context_secret_with_http_info(partner_id, idempotency_key)
|
|
1888
2107
|
p status_code # => 2xx
|
|
1889
2108
|
p headers # => { ... }
|
|
1890
2109
|
p data # => <PartnerEntryContextSecretResponse>
|
|
1891
2110
|
rescue ApiSdkRb::ApiError => e
|
|
1892
|
-
puts "Error when calling PartnersApi->
|
|
2111
|
+
puts "Error when calling PartnersApi->rotate_partner_entry_context_secret_with_http_info: #{e}"
|
|
1893
2112
|
end
|
|
1894
2113
|
```
|
|
1895
2114
|
|
|
@@ -1914,9 +2133,9 @@ end
|
|
|
1914
2133
|
- **Accept**: application/json
|
|
1915
2134
|
|
|
1916
2135
|
|
|
1917
|
-
##
|
|
2136
|
+
## rotate_partner_webhook_secret
|
|
1918
2137
|
|
|
1919
|
-
> <PartnerNotificationSettingsChangeResponse>
|
|
2138
|
+
> <PartnerNotificationSettingsChangeResponse> rotate_partner_webhook_secret(partner_id, idempotency_key)
|
|
1920
2139
|
|
|
1921
2140
|
Make a new secret for your webhook
|
|
1922
2141
|
|
|
@@ -1939,28 +2158,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
1939
2158
|
|
|
1940
2159
|
begin
|
|
1941
2160
|
# Make a new secret for your webhook
|
|
1942
|
-
result = api_instance.
|
|
2161
|
+
result = api_instance.rotate_partner_webhook_secret(partner_id, idempotency_key)
|
|
1943
2162
|
p result
|
|
1944
2163
|
rescue ApiSdkRb::ApiError => e
|
|
1945
|
-
puts "Error when calling PartnersApi->
|
|
2164
|
+
puts "Error when calling PartnersApi->rotate_partner_webhook_secret: #{e}"
|
|
1946
2165
|
end
|
|
1947
2166
|
```
|
|
1948
2167
|
|
|
1949
|
-
#### Using the
|
|
2168
|
+
#### Using the rotate_partner_webhook_secret_with_http_info variant
|
|
1950
2169
|
|
|
1951
2170
|
This returns an Array which contains the response data, status code and headers.
|
|
1952
2171
|
|
|
1953
|
-
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)>
|
|
2172
|
+
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)> rotate_partner_webhook_secret_with_http_info(partner_id, idempotency_key)
|
|
1954
2173
|
|
|
1955
2174
|
```ruby
|
|
1956
2175
|
begin
|
|
1957
2176
|
# Make a new secret for your webhook
|
|
1958
|
-
data, status_code, headers = api_instance.
|
|
2177
|
+
data, status_code, headers = api_instance.rotate_partner_webhook_secret_with_http_info(partner_id, idempotency_key)
|
|
1959
2178
|
p status_code # => 2xx
|
|
1960
2179
|
p headers # => { ... }
|
|
1961
2180
|
p data # => <PartnerNotificationSettingsChangeResponse>
|
|
1962
2181
|
rescue ApiSdkRb::ApiError => e
|
|
1963
|
-
puts "Error when calling PartnersApi->
|
|
2182
|
+
puts "Error when calling PartnersApi->rotate_partner_webhook_secret_with_http_info: #{e}"
|
|
1964
2183
|
end
|
|
1965
2184
|
```
|
|
1966
2185
|
|
|
@@ -1985,9 +2204,9 @@ end
|
|
|
1985
2204
|
- **Accept**: application/json
|
|
1986
2205
|
|
|
1987
2206
|
|
|
1988
|
-
##
|
|
2207
|
+
## send_partner_notification_test_event
|
|
1989
2208
|
|
|
1990
|
-
> <PartnerNotificationTestEventResultResponse>
|
|
2209
|
+
> <PartnerNotificationTestEventResultResponse> send_partner_notification_test_event(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
1991
2210
|
|
|
1992
2211
|
Send a test event to your webhook
|
|
1993
2212
|
|
|
@@ -2011,28 +2230,28 @@ partner_notification_test_event_request = ApiSdkRb::PartnerNotificationTestEvent
|
|
|
2011
2230
|
|
|
2012
2231
|
begin
|
|
2013
2232
|
# Send a test event to your webhook
|
|
2014
|
-
result = api_instance.
|
|
2233
|
+
result = api_instance.send_partner_notification_test_event(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2015
2234
|
p result
|
|
2016
2235
|
rescue ApiSdkRb::ApiError => e
|
|
2017
|
-
puts "Error when calling PartnersApi->
|
|
2236
|
+
puts "Error when calling PartnersApi->send_partner_notification_test_event: #{e}"
|
|
2018
2237
|
end
|
|
2019
2238
|
```
|
|
2020
2239
|
|
|
2021
|
-
#### Using the
|
|
2240
|
+
#### Using the send_partner_notification_test_event_with_http_info variant
|
|
2022
2241
|
|
|
2023
2242
|
This returns an Array which contains the response data, status code and headers.
|
|
2024
2243
|
|
|
2025
|
-
> <Array(<PartnerNotificationTestEventResultResponse>, Integer, Hash)>
|
|
2244
|
+
> <Array(<PartnerNotificationTestEventResultResponse>, Integer, Hash)> send_partner_notification_test_event_with_http_info(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2026
2245
|
|
|
2027
2246
|
```ruby
|
|
2028
2247
|
begin
|
|
2029
2248
|
# Send a test event to your webhook
|
|
2030
|
-
data, status_code, headers = api_instance.
|
|
2249
|
+
data, status_code, headers = api_instance.send_partner_notification_test_event_with_http_info(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2031
2250
|
p status_code # => 2xx
|
|
2032
2251
|
p headers # => { ... }
|
|
2033
2252
|
p data # => <PartnerNotificationTestEventResultResponse>
|
|
2034
2253
|
rescue ApiSdkRb::ApiError => e
|
|
2035
|
-
puts "Error when calling PartnersApi->
|
|
2254
|
+
puts "Error when calling PartnersApi->send_partner_notification_test_event_with_http_info: #{e}"
|
|
2036
2255
|
end
|
|
2037
2256
|
```
|
|
2038
2257
|
|
|
@@ -2058,13 +2277,13 @@ end
|
|
|
2058
2277
|
- **Accept**: application/json
|
|
2059
2278
|
|
|
2060
2279
|
|
|
2061
|
-
##
|
|
2280
|
+
## set_partner_adapter_connection
|
|
2062
2281
|
|
|
2063
|
-
> <
|
|
2282
|
+
> <AdapterConnectionResponse> set_partner_adapter_connection(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2064
2283
|
|
|
2065
2284
|
Connect an adapter key to a partner
|
|
2066
2285
|
|
|
2067
|
-
Gives an adapter the key it needs to act through a service the partner has an account with, for the widgets of the customers the partner manages. Take the `adapterId` and `credentialKey` from `getPartnerAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this partner, 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 or to your customers. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on the partner's 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 a partner may keep it (some are for an owner 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. 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 partner is told once a day what to
|
|
2286
|
+
Gives an adapter the key it needs to act through a service the partner has an account with, for the widgets of the customers the partner manages. Take the `adapterId` and `credentialKey` from `getPartnerAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this partner, 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 or to your customers. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on the partner's 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 a partner may keep it (some are for an owner 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. **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 `getPartnerAdapterConnections`). 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 `confirmPartnerAdapterConnection`. 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 partner is told once a day what to do. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator. A retry is harmless: saving the same key twice only refreshes when it was set.
|
|
2068
2287
|
|
|
2069
2288
|
### Examples
|
|
2070
2289
|
|
|
@@ -2085,28 +2304,28 @@ set_adapter_connection_request = ApiSdkRb::SetAdapterConnectionRequest.new({cred
|
|
|
2085
2304
|
|
|
2086
2305
|
begin
|
|
2087
2306
|
# Connect an adapter key to a partner
|
|
2088
|
-
result = api_instance.
|
|
2307
|
+
result = api_instance.set_partner_adapter_connection(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2089
2308
|
p result
|
|
2090
2309
|
rescue ApiSdkRb::ApiError => e
|
|
2091
|
-
puts "Error when calling PartnersApi->
|
|
2310
|
+
puts "Error when calling PartnersApi->set_partner_adapter_connection: #{e}"
|
|
2092
2311
|
end
|
|
2093
2312
|
```
|
|
2094
2313
|
|
|
2095
|
-
#### Using the
|
|
2314
|
+
#### Using the set_partner_adapter_connection_with_http_info variant
|
|
2096
2315
|
|
|
2097
2316
|
This returns an Array which contains the response data, status code and headers.
|
|
2098
2317
|
|
|
2099
|
-
> <Array(<
|
|
2318
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> set_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2100
2319
|
|
|
2101
2320
|
```ruby
|
|
2102
2321
|
begin
|
|
2103
2322
|
# Connect an adapter key to a partner
|
|
2104
|
-
data, status_code, headers = api_instance.
|
|
2323
|
+
data, status_code, headers = api_instance.set_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2105
2324
|
p status_code # => 2xx
|
|
2106
2325
|
p headers # => { ... }
|
|
2107
|
-
p data # => <
|
|
2326
|
+
p data # => <AdapterConnectionResponse>
|
|
2108
2327
|
rescue ApiSdkRb::ApiError => e
|
|
2109
|
-
puts "Error when calling PartnersApi->
|
|
2328
|
+
puts "Error when calling PartnersApi->set_partner_adapter_connection_with_http_info: #{e}"
|
|
2110
2329
|
end
|
|
2111
2330
|
```
|
|
2112
2331
|
|
|
@@ -2121,7 +2340,7 @@ end
|
|
|
2121
2340
|
|
|
2122
2341
|
### Return type
|
|
2123
2342
|
|
|
2124
|
-
[**
|
|
2343
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
2125
2344
|
|
|
2126
2345
|
### Authorization
|
|
2127
2346
|
|
|
@@ -2133,9 +2352,9 @@ end
|
|
|
2133
2352
|
- **Accept**: application/json
|
|
2134
2353
|
|
|
2135
2354
|
|
|
2136
|
-
##
|
|
2355
|
+
## set_partner_data_database
|
|
2137
2356
|
|
|
2138
|
-
> <PartnerDataDatabaseResponse>
|
|
2357
|
+
> <PartnerDataDatabaseResponse> set_partner_data_database(partner_id, set_partner_data_database_request)
|
|
2139
2358
|
|
|
2140
2359
|
Keep the data of a partner's compositions in a Neon database of its own
|
|
2141
2360
|
|
|
@@ -2158,28 +2377,28 @@ set_partner_data_database_request = ApiSdkRb::SetPartnerDataDatabaseRequest.new(
|
|
|
2158
2377
|
|
|
2159
2378
|
begin
|
|
2160
2379
|
# Keep the data of a partner's compositions in a Neon database of its own
|
|
2161
|
-
result = api_instance.
|
|
2380
|
+
result = api_instance.set_partner_data_database(partner_id, set_partner_data_database_request)
|
|
2162
2381
|
p result
|
|
2163
2382
|
rescue ApiSdkRb::ApiError => e
|
|
2164
|
-
puts "Error when calling PartnersApi->
|
|
2383
|
+
puts "Error when calling PartnersApi->set_partner_data_database: #{e}"
|
|
2165
2384
|
end
|
|
2166
2385
|
```
|
|
2167
2386
|
|
|
2168
|
-
#### Using the
|
|
2387
|
+
#### Using the set_partner_data_database_with_http_info variant
|
|
2169
2388
|
|
|
2170
2389
|
This returns an Array which contains the response data, status code and headers.
|
|
2171
2390
|
|
|
2172
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
2391
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> set_partner_data_database_with_http_info(partner_id, set_partner_data_database_request)
|
|
2173
2392
|
|
|
2174
2393
|
```ruby
|
|
2175
2394
|
begin
|
|
2176
2395
|
# Keep the data of a partner's compositions in a Neon database of its own
|
|
2177
|
-
data, status_code, headers = api_instance.
|
|
2396
|
+
data, status_code, headers = api_instance.set_partner_data_database_with_http_info(partner_id, set_partner_data_database_request)
|
|
2178
2397
|
p status_code # => 2xx
|
|
2179
2398
|
p headers # => { ... }
|
|
2180
2399
|
p data # => <PartnerDataDatabaseResponse>
|
|
2181
2400
|
rescue ApiSdkRb::ApiError => e
|
|
2182
|
-
puts "Error when calling PartnersApi->
|
|
2401
|
+
puts "Error when calling PartnersApi->set_partner_data_database_with_http_info: #{e}"
|
|
2183
2402
|
end
|
|
2184
2403
|
```
|
|
2185
2404
|
|
|
@@ -2204,9 +2423,9 @@ end
|
|
|
2204
2423
|
- **Accept**: application/json
|
|
2205
2424
|
|
|
2206
2425
|
|
|
2207
|
-
##
|
|
2426
|
+
## set_partner_design_defaults
|
|
2208
2427
|
|
|
2209
|
-
> <
|
|
2428
|
+
> <DesignDefaultsResponse> set_partner_design_defaults(partner_id, set_partner_design_defaults_request)
|
|
2210
2429
|
|
|
2211
2430
|
Set or clear partner-wide design defaults
|
|
2212
2431
|
|
|
@@ -2229,28 +2448,28 @@ set_partner_design_defaults_request = ApiSdkRb::SetPartnerDesignDefaultsRequest.
|
|
|
2229
2448
|
|
|
2230
2449
|
begin
|
|
2231
2450
|
# Set or clear partner-wide design defaults
|
|
2232
|
-
result = api_instance.
|
|
2451
|
+
result = api_instance.set_partner_design_defaults(partner_id, set_partner_design_defaults_request)
|
|
2233
2452
|
p result
|
|
2234
2453
|
rescue ApiSdkRb::ApiError => e
|
|
2235
|
-
puts "Error when calling PartnersApi->
|
|
2454
|
+
puts "Error when calling PartnersApi->set_partner_design_defaults: #{e}"
|
|
2236
2455
|
end
|
|
2237
2456
|
```
|
|
2238
2457
|
|
|
2239
|
-
#### Using the
|
|
2458
|
+
#### Using the set_partner_design_defaults_with_http_info variant
|
|
2240
2459
|
|
|
2241
2460
|
This returns an Array which contains the response data, status code and headers.
|
|
2242
2461
|
|
|
2243
|
-
> <Array(<
|
|
2462
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> set_partner_design_defaults_with_http_info(partner_id, set_partner_design_defaults_request)
|
|
2244
2463
|
|
|
2245
2464
|
```ruby
|
|
2246
2465
|
begin
|
|
2247
2466
|
# Set or clear partner-wide design defaults
|
|
2248
|
-
data, status_code, headers = api_instance.
|
|
2467
|
+
data, status_code, headers = api_instance.set_partner_design_defaults_with_http_info(partner_id, set_partner_design_defaults_request)
|
|
2249
2468
|
p status_code # => 2xx
|
|
2250
2469
|
p headers # => { ... }
|
|
2251
|
-
p data # => <
|
|
2470
|
+
p data # => <DesignDefaultsResponse>
|
|
2252
2471
|
rescue ApiSdkRb::ApiError => e
|
|
2253
|
-
puts "Error when calling PartnersApi->
|
|
2472
|
+
puts "Error when calling PartnersApi->set_partner_design_defaults_with_http_info: #{e}"
|
|
2254
2473
|
end
|
|
2255
2474
|
```
|
|
2256
2475
|
|
|
@@ -2263,7 +2482,7 @@ end
|
|
|
2263
2482
|
|
|
2264
2483
|
### Return type
|
|
2265
2484
|
|
|
2266
|
-
[**
|
|
2485
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
2267
2486
|
|
|
2268
2487
|
### Authorization
|
|
2269
2488
|
|
|
@@ -2275,9 +2494,9 @@ end
|
|
|
2275
2494
|
- **Accept**: application/json
|
|
2276
2495
|
|
|
2277
2496
|
|
|
2278
|
-
##
|
|
2497
|
+
## set_partner_preset
|
|
2279
2498
|
|
|
2280
|
-
> <PartnerPresetResponse>
|
|
2499
|
+
> <PartnerPresetResponse> set_partner_preset(partner_id, key, set_partner_preset_request)
|
|
2281
2500
|
|
|
2282
2501
|
Make a widget a preset, or replace a preset
|
|
2283
2502
|
|
|
@@ -2301,28 +2520,28 @@ set_partner_preset_request = ApiSdkRb::SetPartnerPresetRequest.new({widget_id: '
|
|
|
2301
2520
|
|
|
2302
2521
|
begin
|
|
2303
2522
|
# Make a widget a preset, or replace a preset
|
|
2304
|
-
result = api_instance.
|
|
2523
|
+
result = api_instance.set_partner_preset(partner_id, key, set_partner_preset_request)
|
|
2305
2524
|
p result
|
|
2306
2525
|
rescue ApiSdkRb::ApiError => e
|
|
2307
|
-
puts "Error when calling PartnersApi->
|
|
2526
|
+
puts "Error when calling PartnersApi->set_partner_preset: #{e}"
|
|
2308
2527
|
end
|
|
2309
2528
|
```
|
|
2310
2529
|
|
|
2311
|
-
#### Using the
|
|
2530
|
+
#### Using the set_partner_preset_with_http_info variant
|
|
2312
2531
|
|
|
2313
2532
|
This returns an Array which contains the response data, status code and headers.
|
|
2314
2533
|
|
|
2315
|
-
> <Array(<PartnerPresetResponse>, Integer, Hash)>
|
|
2534
|
+
> <Array(<PartnerPresetResponse>, Integer, Hash)> set_partner_preset_with_http_info(partner_id, key, set_partner_preset_request)
|
|
2316
2535
|
|
|
2317
2536
|
```ruby
|
|
2318
2537
|
begin
|
|
2319
2538
|
# Make a widget a preset, or replace a preset
|
|
2320
|
-
data, status_code, headers = api_instance.
|
|
2539
|
+
data, status_code, headers = api_instance.set_partner_preset_with_http_info(partner_id, key, set_partner_preset_request)
|
|
2321
2540
|
p status_code # => 2xx
|
|
2322
2541
|
p headers # => { ... }
|
|
2323
2542
|
p data # => <PartnerPresetResponse>
|
|
2324
2543
|
rescue ApiSdkRb::ApiError => e
|
|
2325
|
-
puts "Error when calling PartnersApi->
|
|
2544
|
+
puts "Error when calling PartnersApi->set_partner_preset_with_http_info: #{e}"
|
|
2326
2545
|
end
|
|
2327
2546
|
```
|
|
2328
2547
|
|
|
@@ -2348,13 +2567,13 @@ end
|
|
|
2348
2567
|
- **Accept**: application/json
|
|
2349
2568
|
|
|
2350
2569
|
|
|
2351
|
-
##
|
|
2570
|
+
## set_partner_storage_destination
|
|
2352
2571
|
|
|
2353
|
-
> <PartnerStorageDestinationResponse>
|
|
2572
|
+
> <PartnerStorageDestinationResponse> set_partner_storage_destination(partner_id, set_partner_storage_destination_request)
|
|
2354
2573
|
|
|
2355
2574
|
Set where a partner's uploaded files are stored
|
|
2356
2575
|
|
|
2357
|
-
Points the partner at a bucket of its own on an S3-compatible service (Cloudflare R2, Amazon S3, Wasabi, MinIO and the like). From then on, every file the account that administers the partner stores is kept in that bucket instead of with Widgetic, whichever way it arrives: a file sent with `
|
|
2576
|
+
Points the partner at a bucket of its own on an S3-compatible service (Cloudflare R2, Amazon S3, Wasabi, MinIO and the like). From then on, every file the account that administers the partner stores is kept in that bucket instead of with Widgetic, whichever way it arrives: a file sent with `uploadFile` (with an API key, an SDK token, an editor session or from the Widgetic website), a resumable upload, the media library, and the files the agent tools and the MCP server save. It takes none of the account's storage allowance, and its `url` is served from `publicBaseUrl`. The chunks of a resumable upload wait in Widgetic's temporary staging area until it is completed and are removed then: the finished file is stored in your bucket and nowhere else. A destination is required. Partner storage is not optional: your customers' files, and your own however they arrive, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination (on any route, including a resumable upload, which is refused when it is started) is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<keyPrefix>widgetic-check/`, reads it back from `<publicBaseUrl>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `publicBaseUrl`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner's.
|
|
2358
2577
|
|
|
2359
2578
|
### Examples
|
|
2360
2579
|
|
|
@@ -2373,28 +2592,28 @@ set_partner_storage_destination_request = ApiSdkRb::SetPartnerStorageDestination
|
|
|
2373
2592
|
|
|
2374
2593
|
begin
|
|
2375
2594
|
# Set where a partner's uploaded files are stored
|
|
2376
|
-
result = api_instance.
|
|
2595
|
+
result = api_instance.set_partner_storage_destination(partner_id, set_partner_storage_destination_request)
|
|
2377
2596
|
p result
|
|
2378
2597
|
rescue ApiSdkRb::ApiError => e
|
|
2379
|
-
puts "Error when calling PartnersApi->
|
|
2598
|
+
puts "Error when calling PartnersApi->set_partner_storage_destination: #{e}"
|
|
2380
2599
|
end
|
|
2381
2600
|
```
|
|
2382
2601
|
|
|
2383
|
-
#### Using the
|
|
2602
|
+
#### Using the set_partner_storage_destination_with_http_info variant
|
|
2384
2603
|
|
|
2385
2604
|
This returns an Array which contains the response data, status code and headers.
|
|
2386
2605
|
|
|
2387
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
2606
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> set_partner_storage_destination_with_http_info(partner_id, set_partner_storage_destination_request)
|
|
2388
2607
|
|
|
2389
2608
|
```ruby
|
|
2390
2609
|
begin
|
|
2391
2610
|
# Set where a partner's uploaded files are stored
|
|
2392
|
-
data, status_code, headers = api_instance.
|
|
2611
|
+
data, status_code, headers = api_instance.set_partner_storage_destination_with_http_info(partner_id, set_partner_storage_destination_request)
|
|
2393
2612
|
p status_code # => 2xx
|
|
2394
2613
|
p headers # => { ... }
|
|
2395
2614
|
p data # => <PartnerStorageDestinationResponse>
|
|
2396
2615
|
rescue ApiSdkRb::ApiError => e
|
|
2397
|
-
puts "Error when calling PartnersApi->
|
|
2616
|
+
puts "Error when calling PartnersApi->set_partner_storage_destination_with_http_info: #{e}"
|
|
2398
2617
|
end
|
|
2399
2618
|
```
|
|
2400
2619
|
|
|
@@ -2419,9 +2638,82 @@ end
|
|
|
2419
2638
|
- **Accept**: application/json
|
|
2420
2639
|
|
|
2421
2640
|
|
|
2422
|
-
##
|
|
2641
|
+
## set_partner_workflow_preset
|
|
2642
|
+
|
|
2643
|
+
> <SetPartnerWorkflowPreset200Response> set_partner_workflow_preset(partner_id, key, offer_workflow_preset_request)
|
|
2644
|
+
|
|
2645
|
+
Offer a workflow as a place to start, or replace what a key offers
|
|
2646
|
+
|
|
2647
|
+
Offers one of the partner account's own published workflows to its managed users under `key`. If the partner already offers something under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole starting point: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit. A workflow is offered once. What people get is the workflow's live version as it is when they start, so publishing the workflow changes what new starts get; workflows people already started are never touched. The offer is refused, and `error.details.reason` says why, when the workflow: - is not the partner account's own (a workflow of a team or of a customer, or of somebody else), or does not exist: 404, the same for both; - is archived (409 `workflow_archived`), or was never published (409 `workflow_not_published`); - shows no composition (422 `workflow_empty`), or a block shows a composition made for a customer or a team (422 `composition_not_own`); - chains more than 10 widgets (422 `too_many_widgets`), or a widget that the partner does not offer as a preset (422 `widget_not_preset`; `error.details.widgets` lists them, each with its `id` and `name`, so they can be offered first with `setPartnerPreset`); - is already offered under another key (409 `workflow_already_offered`; `error.details.key` says which), or the partner already offers 50 (409 `too_many_presets`). The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator, who offers the partner's workflow on its behalf.
|
|
2648
|
+
|
|
2649
|
+
### Examples
|
|
2650
|
+
|
|
2651
|
+
```ruby
|
|
2652
|
+
require 'time'
|
|
2653
|
+
require 'api-sdk-rb'
|
|
2654
|
+
# setup authorization
|
|
2655
|
+
ApiSdkRb.configure do |config|
|
|
2656
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
2657
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2658
|
+
end
|
|
2659
|
+
|
|
2660
|
+
api_instance = ApiSdkRb::PartnersApi.new
|
|
2661
|
+
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting point to set
|
|
2662
|
+
key = 'key_example' # String | The name your code and the picker use for the starting point
|
|
2663
|
+
offer_workflow_preset_request = ApiSdkRb::OfferWorkflowPresetRequest.new({workflow_id: 'workflow_id_example'}) # OfferWorkflowPresetRequest |
|
|
2664
|
+
|
|
2665
|
+
begin
|
|
2666
|
+
# Offer a workflow as a place to start, or replace what a key offers
|
|
2667
|
+
result = api_instance.set_partner_workflow_preset(partner_id, key, offer_workflow_preset_request)
|
|
2668
|
+
p result
|
|
2669
|
+
rescue ApiSdkRb::ApiError => e
|
|
2670
|
+
puts "Error when calling PartnersApi->set_partner_workflow_preset: #{e}"
|
|
2671
|
+
end
|
|
2672
|
+
```
|
|
2673
|
+
|
|
2674
|
+
#### Using the set_partner_workflow_preset_with_http_info variant
|
|
2675
|
+
|
|
2676
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2677
|
+
|
|
2678
|
+
> <Array(<SetPartnerWorkflowPreset200Response>, Integer, Hash)> set_partner_workflow_preset_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
2679
|
+
|
|
2680
|
+
```ruby
|
|
2681
|
+
begin
|
|
2682
|
+
# Offer a workflow as a place to start, or replace what a key offers
|
|
2683
|
+
data, status_code, headers = api_instance.set_partner_workflow_preset_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
2684
|
+
p status_code # => 2xx
|
|
2685
|
+
p headers # => { ... }
|
|
2686
|
+
p data # => <SetPartnerWorkflowPreset200Response>
|
|
2687
|
+
rescue ApiSdkRb::ApiError => e
|
|
2688
|
+
puts "Error when calling PartnersApi->set_partner_workflow_preset_with_http_info: #{e}"
|
|
2689
|
+
end
|
|
2690
|
+
```
|
|
2691
|
+
|
|
2692
|
+
### Parameters
|
|
2693
|
+
|
|
2694
|
+
| Name | Type | Description | Notes |
|
|
2695
|
+
| ---- | ---- | ----------- | ----- |
|
|
2696
|
+
| **partner_id** | **String** | The partner whose starting point to set | |
|
|
2697
|
+
| **key** | **String** | The name your code and the picker use for the starting point | |
|
|
2698
|
+
| **offer_workflow_preset_request** | [**OfferWorkflowPresetRequest**](OfferWorkflowPresetRequest.md) | | |
|
|
2699
|
+
|
|
2700
|
+
### Return type
|
|
2701
|
+
|
|
2702
|
+
[**SetPartnerWorkflowPreset200Response**](SetPartnerWorkflowPreset200Response.md)
|
|
2703
|
+
|
|
2704
|
+
### Authorization
|
|
2705
|
+
|
|
2706
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
2707
|
+
|
|
2708
|
+
### HTTP request headers
|
|
2709
|
+
|
|
2710
|
+
- **Content-Type**: application/json
|
|
2711
|
+
- **Accept**: application/json
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
## update_partner_entry_context_signing
|
|
2423
2715
|
|
|
2424
|
-
> <PartnerEntryContextSigningResponse>
|
|
2716
|
+
> <PartnerEntryContextSigningResponse> update_partner_entry_context_signing(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2425
2717
|
|
|
2426
2718
|
Require a signed context, or stop requiring it
|
|
2427
2719
|
|
|
@@ -2447,28 +2739,28 @@ opts = {
|
|
|
2447
2739
|
|
|
2448
2740
|
begin
|
|
2449
2741
|
# Require a signed context, or stop requiring it
|
|
2450
|
-
result = api_instance.
|
|
2742
|
+
result = api_instance.update_partner_entry_context_signing(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2451
2743
|
p result
|
|
2452
2744
|
rescue ApiSdkRb::ApiError => e
|
|
2453
|
-
puts "Error when calling PartnersApi->
|
|
2745
|
+
puts "Error when calling PartnersApi->update_partner_entry_context_signing: #{e}"
|
|
2454
2746
|
end
|
|
2455
2747
|
```
|
|
2456
2748
|
|
|
2457
|
-
#### Using the
|
|
2749
|
+
#### Using the update_partner_entry_context_signing_with_http_info variant
|
|
2458
2750
|
|
|
2459
2751
|
This returns an Array which contains the response data, status code and headers.
|
|
2460
2752
|
|
|
2461
|
-
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)>
|
|
2753
|
+
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)> update_partner_entry_context_signing_with_http_info(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2462
2754
|
|
|
2463
2755
|
```ruby
|
|
2464
2756
|
begin
|
|
2465
2757
|
# Require a signed context, or stop requiring it
|
|
2466
|
-
data, status_code, headers = api_instance.
|
|
2758
|
+
data, status_code, headers = api_instance.update_partner_entry_context_signing_with_http_info(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2467
2759
|
p status_code # => 2xx
|
|
2468
2760
|
p headers # => { ... }
|
|
2469
2761
|
p data # => <PartnerEntryContextSigningResponse>
|
|
2470
2762
|
rescue ApiSdkRb::ApiError => e
|
|
2471
|
-
puts "Error when calling PartnersApi->
|
|
2763
|
+
puts "Error when calling PartnersApi->update_partner_entry_context_signing_with_http_info: #{e}"
|
|
2472
2764
|
end
|
|
2473
2765
|
```
|
|
2474
2766
|
|
|
@@ -2494,9 +2786,9 @@ end
|
|
|
2494
2786
|
- **Accept**: application/json
|
|
2495
2787
|
|
|
2496
2788
|
|
|
2497
|
-
##
|
|
2789
|
+
## update_partner_notification_settings
|
|
2498
2790
|
|
|
2499
|
-
> <PartnerNotificationSettingsChangeResponse>
|
|
2791
|
+
> <PartnerNotificationSettingsChangeResponse> update_partner_notification_settings(partner_id, update_partner_notification_settings_request, opts)
|
|
2500
2792
|
|
|
2501
2793
|
Choose where your notifications go
|
|
2502
2794
|
|
|
@@ -2522,28 +2814,28 @@ opts = {
|
|
|
2522
2814
|
|
|
2523
2815
|
begin
|
|
2524
2816
|
# Choose where your notifications go
|
|
2525
|
-
result = api_instance.
|
|
2817
|
+
result = api_instance.update_partner_notification_settings(partner_id, update_partner_notification_settings_request, opts)
|
|
2526
2818
|
p result
|
|
2527
2819
|
rescue ApiSdkRb::ApiError => e
|
|
2528
|
-
puts "Error when calling PartnersApi->
|
|
2820
|
+
puts "Error when calling PartnersApi->update_partner_notification_settings: #{e}"
|
|
2529
2821
|
end
|
|
2530
2822
|
```
|
|
2531
2823
|
|
|
2532
|
-
#### Using the
|
|
2824
|
+
#### Using the update_partner_notification_settings_with_http_info variant
|
|
2533
2825
|
|
|
2534
2826
|
This returns an Array which contains the response data, status code and headers.
|
|
2535
2827
|
|
|
2536
|
-
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)>
|
|
2828
|
+
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)> update_partner_notification_settings_with_http_info(partner_id, update_partner_notification_settings_request, opts)
|
|
2537
2829
|
|
|
2538
2830
|
```ruby
|
|
2539
2831
|
begin
|
|
2540
2832
|
# Choose where your notifications go
|
|
2541
|
-
data, status_code, headers = api_instance.
|
|
2833
|
+
data, status_code, headers = api_instance.update_partner_notification_settings_with_http_info(partner_id, update_partner_notification_settings_request, opts)
|
|
2542
2834
|
p status_code # => 2xx
|
|
2543
2835
|
p headers # => { ... }
|
|
2544
2836
|
p data # => <PartnerNotificationSettingsChangeResponse>
|
|
2545
2837
|
rescue ApiSdkRb::ApiError => e
|
|
2546
|
-
puts "Error when calling PartnersApi->
|
|
2838
|
+
puts "Error when calling PartnersApi->update_partner_notification_settings_with_http_info: #{e}"
|
|
2547
2839
|
end
|
|
2548
2840
|
```
|
|
2549
2841
|
|
|
@@ -2569,9 +2861,9 @@ end
|
|
|
2569
2861
|
- **Accept**: application/json
|
|
2570
2862
|
|
|
2571
2863
|
|
|
2572
|
-
##
|
|
2864
|
+
## verify_partner_data_database
|
|
2573
2865
|
|
|
2574
|
-
> <PartnerDataDatabaseResponse>
|
|
2866
|
+
> <PartnerDataDatabaseResponse> verify_partner_data_database(partner_id)
|
|
2575
2867
|
|
|
2576
2868
|
Check that a partner's own database still works
|
|
2577
2869
|
|
|
@@ -2593,28 +2885,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
2593
2885
|
|
|
2594
2886
|
begin
|
|
2595
2887
|
# Check that a partner's own database still works
|
|
2596
|
-
result = api_instance.
|
|
2888
|
+
result = api_instance.verify_partner_data_database(partner_id)
|
|
2597
2889
|
p result
|
|
2598
2890
|
rescue ApiSdkRb::ApiError => e
|
|
2599
|
-
puts "Error when calling PartnersApi->
|
|
2891
|
+
puts "Error when calling PartnersApi->verify_partner_data_database: #{e}"
|
|
2600
2892
|
end
|
|
2601
2893
|
```
|
|
2602
2894
|
|
|
2603
|
-
#### Using the
|
|
2895
|
+
#### Using the verify_partner_data_database_with_http_info variant
|
|
2604
2896
|
|
|
2605
2897
|
This returns an Array which contains the response data, status code and headers.
|
|
2606
2898
|
|
|
2607
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
2899
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> verify_partner_data_database_with_http_info(partner_id)
|
|
2608
2900
|
|
|
2609
2901
|
```ruby
|
|
2610
2902
|
begin
|
|
2611
2903
|
# Check that a partner's own database still works
|
|
2612
|
-
data, status_code, headers = api_instance.
|
|
2904
|
+
data, status_code, headers = api_instance.verify_partner_data_database_with_http_info(partner_id)
|
|
2613
2905
|
p status_code # => 2xx
|
|
2614
2906
|
p headers # => { ... }
|
|
2615
2907
|
p data # => <PartnerDataDatabaseResponse>
|
|
2616
2908
|
rescue ApiSdkRb::ApiError => e
|
|
2617
|
-
puts "Error when calling PartnersApi->
|
|
2909
|
+
puts "Error when calling PartnersApi->verify_partner_data_database_with_http_info: #{e}"
|
|
2618
2910
|
end
|
|
2619
2911
|
```
|
|
2620
2912
|
|
|
@@ -2638,9 +2930,9 @@ end
|
|
|
2638
2930
|
- **Accept**: application/json
|
|
2639
2931
|
|
|
2640
2932
|
|
|
2641
|
-
##
|
|
2933
|
+
## verify_partner_storage_destination
|
|
2642
2934
|
|
|
2643
|
-
> <PartnerStorageDestinationResponse>
|
|
2935
|
+
> <PartnerStorageDestinationResponse> verify_partner_storage_destination(partner_id)
|
|
2644
2936
|
|
|
2645
2937
|
Check that a partner's storage destination still works
|
|
2646
2938
|
|
|
@@ -2662,28 +2954,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
2662
2954
|
|
|
2663
2955
|
begin
|
|
2664
2956
|
# Check that a partner's storage destination still works
|
|
2665
|
-
result = api_instance.
|
|
2957
|
+
result = api_instance.verify_partner_storage_destination(partner_id)
|
|
2666
2958
|
p result
|
|
2667
2959
|
rescue ApiSdkRb::ApiError => e
|
|
2668
|
-
puts "Error when calling PartnersApi->
|
|
2960
|
+
puts "Error when calling PartnersApi->verify_partner_storage_destination: #{e}"
|
|
2669
2961
|
end
|
|
2670
2962
|
```
|
|
2671
2963
|
|
|
2672
|
-
#### Using the
|
|
2964
|
+
#### Using the verify_partner_storage_destination_with_http_info variant
|
|
2673
2965
|
|
|
2674
2966
|
This returns an Array which contains the response data, status code and headers.
|
|
2675
2967
|
|
|
2676
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
2968
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> verify_partner_storage_destination_with_http_info(partner_id)
|
|
2677
2969
|
|
|
2678
2970
|
```ruby
|
|
2679
2971
|
begin
|
|
2680
2972
|
# Check that a partner's storage destination still works
|
|
2681
|
-
data, status_code, headers = api_instance.
|
|
2973
|
+
data, status_code, headers = api_instance.verify_partner_storage_destination_with_http_info(partner_id)
|
|
2682
2974
|
p status_code # => 2xx
|
|
2683
2975
|
p headers # => { ... }
|
|
2684
2976
|
p data # => <PartnerStorageDestinationResponse>
|
|
2685
2977
|
rescue ApiSdkRb::ApiError => e
|
|
2686
|
-
puts "Error when calling PartnersApi->
|
|
2978
|
+
puts "Error when calling PartnersApi->verify_partner_storage_destination_with_http_info: #{e}"
|
|
2687
2979
|
end
|
|
2688
2980
|
```
|
|
2689
2981
|
|