api-sdk-rb 1.11.66 → 1.11.111
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 +192 -9
- data/docs/AdapterConnection.md +7 -1
- 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 +24 -0
- data/docs/BrandKitTokensFonts.md +24 -0
- data/docs/BrandKitView.md +36 -0
- data/docs/BrandKitViewOwner.md +20 -0
- data/docs/BrandKitViewResponse.md +22 -0
- data/docs/BrandSpacing.md +32 -0
- data/docs/Composition.md +5 -1
- data/docs/CompositionLastEditedBy.md +20 -0
- data/docs/CompositionsApi.md +217 -135
- data/docs/ConfirmAdapterConnectionRequest.md +18 -0
- data/docs/CreateWidget201ResponseData.md +2 -4
- data/docs/CreateWorkspaceWorkflowFromPreset201Response.md +22 -0
- data/docs/CreateWorkspaceWorkflowFromPresetRequest.md +20 -0
- data/docs/CreateWorkspaceWorkflowRequest.md +22 -0
- data/docs/DeleteWorkspaceWorkflow200Response.md +22 -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/GetPublicWorkflow200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowStats200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowVersion200Response.md +22 -0
- data/docs/ListPartnerWorkflowPresets200Response.md +22 -0
- 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/ManagedUsersApi.md +1 -1
- 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/PartnerApi.md +3360 -538
- data/docs/PartnerCustomization.md +2 -2
- data/docs/PartnerNotification.md +1 -1
- data/docs/PartnersApi.md +294 -2
- data/docs/PatchBrandKitAssetRequest.md +24 -0
- data/docs/PatchBrandKitRequest.md +28 -0
- data/docs/PatchBrandKitRequestFonts.md +24 -0
- data/docs/PatchBrandKitRequestSpacing.md +32 -0
- data/docs/PostBrandKitIconRequest.md +20 -0
- data/docs/PublicEmbedApi.md +270 -4
- data/docs/PublicWorkflow.md +36 -0
- data/docs/PublicWorkflowEventsAccepted.md +22 -0
- data/docs/PublicWorkflowEventsRequest.md +24 -0
- data/docs/PublicWorkflowEventsRequestEventsInner.md +22 -0
- data/docs/PublicWorkflowEventsRequestHeightsInner.md +20 -0
- 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/SaveWorkspaceWorkflow200Response.md +22 -0
- data/docs/SaveWorkspaceWorkflowRequest.md +24 -0
- data/docs/SetAdapterConnectionRequest.md +1 -1
- data/docs/SetPartnerWorkflowPreset200Response.md +22 -0
- data/docs/UpdateComposition.md +1 -1
- data/docs/UsersApi.md +77 -1
- data/docs/Widget.md +2 -4
- 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/WorkflowEdge.md +24 -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/WorkflowSchedule.md +24 -0
- data/docs/WorkflowStats.md +32 -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 +1743 -0
- data/docs/WorkspacesApi.md +1527 -0
- data/lib/api-sdk-rb/api/brand_kit_api.rb +581 -0
- data/lib/api-sdk-rb/api/compositions_api.rb +237 -138
- data/lib/api-sdk-rb/api/managed_users_api.rb +2 -2
- data/lib/api-sdk-rb/api/partner_api.rb +3907 -809
- data/lib/api-sdk-rb/api/partners_api.rb +320 -4
- data/lib/api-sdk-rb/api/public_embed_api.rb +283 -6
- data/lib/api-sdk-rb/api/users_api.rb +96 -2
- data/lib/api-sdk-rb/api/workflows_api.rb +1997 -0
- data/lib/api-sdk-rb/api/workspaces_api.rb +1775 -0
- data/lib/api-sdk-rb/configuration.rb +50 -2
- data/lib/api-sdk-rb/models/adapter_connection.rb +48 -5
- 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 +304 -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/composition.rb +26 -5
- 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/create_widget201_response_data.rb +9 -20
- data/lib/api-sdk-rb/models/create_workspace_workflow_from_preset201_response.rb +246 -0
- 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/delete_workspace_workflow200_response.rb +246 -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_public_workflow200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_stats200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_version200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_partner_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_composition_options200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_versions200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflows200_response.rb +246 -0
- 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 +332 -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 +332 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_heights_inner.rb +267 -0
- data/lib/api-sdk-rb/models/public_workflow_translation.rb +242 -0
- data/lib/api-sdk-rb/models/publish_workspace_workflow200_response.rb +246 -0
- 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_partner_workflow_preset200_response.rb +246 -0
- data/lib/api-sdk-rb/models/report_public_workflow_events200_response.rb +246 -0
- data/lib/api-sdk-rb/models/save_workspace_workflow200_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/set_partner_workflow_preset200_response.rb +246 -0
- data/lib/api-sdk-rb/models/update_composition.rb +1 -1
- data/lib/api-sdk-rb/models/widget.rb +9 -20
- 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_edge.rb +292 -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_schedule.rb +298 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +335 -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 +88 -0
- data/spec/api/brand_kit_api_spec.rb +136 -0
- data/spec/api/compositions_api_spec.rb +86 -69
- data/spec/api/managed_users_api_spec.rb +1 -1
- data/spec/api/partner_api_spec.rb +624 -82
- data/spec/api/partners_api_spec.rb +56 -2
- data/spec/api/public_embed_api_spec.rb +54 -3
- data/spec/api/users_api_spec.rb +16 -1
- data/spec/api/workflows_api_spec.rb +378 -0
- data/spec/api/workspaces_api_spec.rb +339 -0
- data/spec/models/adapter_connection_spec.rb +18 -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 +54 -0
- data/spec/models/brand_kit_view_owner_spec.rb +46 -0
- data/spec/models/brand_kit_view_response_spec.rb +48 -0
- data/spec/models/brand_kit_view_spec.rb +90 -0
- data/spec/models/brand_spacing_spec.rb +78 -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/create_widget201_response_data_spec.rb +1 -7
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +48 -0
- 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/delete_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +1 -1
- 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_public_workflow200_response_spec.rb +48 -0
- data/spec/models/get_workspace_workflow_stats200_response_spec.rb +48 -0
- data/spec/models/get_workspace_workflow_version200_response_spec.rb +48 -0
- data/spec/models/list_partner_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_composition_options200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_versions200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflows200_response_spec.rb +48 -0
- 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 +66 -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 +52 -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_spec.rb +94 -0
- data/spec/models/public_workflow_translation_spec.rb +42 -0
- data/spec/models/publish_workspace_workflow200_response_spec.rb +48 -0
- 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/remove_partner_workflow_preset200_response_spec.rb +48 -0
- data/spec/models/report_public_workflow_events200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow_request_spec.rb +54 -0
- data/spec/models/set_partner_workflow_preset200_response_spec.rb +48 -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_spec.rb +162 -0
- data/spec/models/workflow_edge_spec.rb +54 -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/workflow_list_spec.rb +54 -0
- 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_schedule_spec.rb +62 -0
- data/spec/models/workflow_spec.rb +132 -0
- data/spec/models/workflow_stats_spec.rb +78 -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 +364 -12
|
@@ -39,8 +39,8 @@ instance = ApiSdkRb::PartnerCustomization.new(
|
|
|
39
39
|
billing_cycle: annual,
|
|
40
40
|
minimum_commitment_months: 12,
|
|
41
41
|
support_sla: 99.9%,
|
|
42
|
-
contract_start_date: Mon Jan 01
|
|
43
|
-
contract_end_date: Tue Dec 31
|
|
42
|
+
contract_start_date: Mon Jan 01 01:00:00 CET 2024,
|
|
43
|
+
contract_end_date: Tue Dec 31 01:00:00 CET 2024,
|
|
44
44
|
notes: Special pricing for strategic partner,
|
|
45
45
|
is_active_contract: true,
|
|
46
46
|
created_at: null,
|
data/docs/PartnerNotification.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **title** | **String** | One line that says what happened | |
|
|
10
10
|
| **body** | **String** | A few sentences that say what happened and what to do about it | |
|
|
11
11
|
| **tone** | **String** | How serious it is | |
|
|
12
|
-
| **data** | **Hash<String, Object>** | The facts of the event, named in camelCase. An invoice event carries `invoiceNumber`, `subtotal`, `taxAmount`, `total`, `currency`, `dueDate`, `hostedInvoiceUrl` (the page where it is paid) and `purpose` (`contract`, or `extra_credits` for credits you bought on top of the contract: an unpaid invoice for extra credits never stops the account, the credits are just not added until it is paid); a payment adds `paidAt`, a failed payment `reason`, a reminder `daysUntilDue` or `daysOverdue`. A credits event carries `band` (`low` or `empty`), `balance` and `threshold`. `credits.managed_user_cap_reached` (one of your managed users used its monthly credits and a request was refused) goes to your webhook only when subscribed, once per managed user each month, and carries `managedUserId`, `externalId`, `monthlyCredits`, `creditsUsed`, `resetsAt` and `reachedAt`. A standing event carries `status`, `previousStatus` and `reason`; `partner.paused` with `status: payment_arrears` means that an overdue invoice stopped the account (nobody paused it, and `reason` names the invoice), and `partner.resumed` with `previousStatus: payment_arrears` means that its payment ended that. A storage event carries `reason` and `checkedAt`. Content events (`composition.created`, `composition.updated`, `widget.published`, `upload.created`, `entry.created`) go to your webhook only when subscribed; they do not appear in the dashboard list. `composition.created` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId` and `createdAt`; `composition.updated` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId`, `contentVersion` and `savedAt`, and is sent for the first save of a composition in each five minutes (read the composition for its current state); `widget.published` carries `widgetId`, `name`, `managedUserId`, `externalId`, `version` and `publishedAt`; `upload.created` carries `uploadId`, `name`, `mimeType`, `sizeBytes`, `address`, `managedUserId`, `externalId`, `purpose` and `createdAt`; `entry.created` carries `compositionId`, `table`, `entryId`, `createdAt` and `context` (the host attribution of the embedding page, or null), and none of the values the visitor entered: read those with the entries routes. Ignore an event type you do not know: more may be added. `sendPartnerNotificationTestEvent` sends a sample of every one of them. | |
|
|
12
|
+
| **data** | **Hash<String, Object>** | The facts of the event, named in camelCase. An invoice event carries `invoiceNumber`, `subtotal`, `taxAmount`, `total`, `currency`, `dueDate`, `hostedInvoiceUrl` (the page where it is paid) and `purpose` (`contract`, or `extra_credits` for credits you bought on top of the contract: an unpaid invoice for extra credits never stops the account, the credits are just not added until it is paid); a payment adds `paidAt`, a failed payment `reason`, a reminder `daysUntilDue` or `daysOverdue`. A credits event carries `band` (`low` or `empty`), `balance` and `threshold`. `credits.managed_user_cap_reached` (one of your managed users used its monthly credits and a request was refused) goes to your webhook only when subscribed, once per managed user each month, and carries `managedUserId`, `externalId`, `monthlyCredits`, `creditsUsed`, `resetsAt` and `reachedAt`. A standing event carries `status`, `previousStatus` and `reason`; `partner.paused` with `status: payment_arrears` means that an overdue invoice stopped the account (nobody paused it, and `reason` names the invoice), and `partner.resumed` with `previousStatus: payment_arrears` means that its payment ended that. A storage event carries `reason` and `checkedAt`. Content events (`composition.created`, `composition.updated`, `widget.published`, `upload.created`, `entry.created`, `workflow.created`, `workflow.published`, `workflow.state_changed`, `workflow.deleted`) go to your webhook only when subscribed; they do not appear in the dashboard list. `composition.created` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId` and `createdAt`; `composition.updated` carries `compositionId`, `widgetId`, `name`, `managedUserId`, `externalId`, `contentVersion` and `savedAt`, and is sent for the first save of a composition in each five minutes (read the composition for its current state); `widget.published` carries `widgetId`, `name`, `managedUserId`, `externalId`, `version` and `publishedAt`; `upload.created` carries `uploadId`, `name`, `mimeType`, `sizeBytes`, `address`, `managedUserId`, `externalId`, `purpose` and `createdAt`; `entry.created` carries `compositionId`, `table`, `entryId`, `createdAt` and `context` (the host attribution of the embedding page, or null), and none of the values the visitor entered: read those with the entries routes. The four workflow events are about the workflows your managed users make (only a workflow made for a managed user is told; one your own people made is not). `workflow.created` carries `workflowId`, `name`, `managedUserId`, `externalId`, `createdAt` and `presetKey` (the key you gave the starting point the workflow was started from with `setPartnerWorkflowPreset`, or null when it was drawn new or copied), and is sent for a copy of a workflow and for a start from a starting point too; `workflow.published` carries `workflowId`, `name`, `managedUserId`, `externalId`, `versionId`, `versionNumber` (1 for the first publication) and `publishedAt`; `workflow.state_changed` carries `workflowId`, `name`, `managedUserId`, `externalId`, `action` (`pause`, `resume`, `archive` or `unarchive`), `previousStatus` and `status` (each `draft`, `live`, `paused` or `archived`) and `changedAt`; `workflow.deleted` carries `workflowId`, `name`, `managedUserId`, `externalId`, `previousStatus` (the state it was in when it was deleted: `draft`, `live`, `paused` or `archived`) and `deletedAt`, and means that the workflow with its versions and counts is gone (the compositions it chained are not touched). Read the workflow for what it holds now (a deleted one is not found). Ignore an event type you do not know: more may be added. `sendPartnerNotificationTestEvent` sends a sample of every one of them. | |
|
|
13
13
|
| **created_at** | **Time** | | |
|
|
14
14
|
|
|
15
15
|
## Example
|
data/docs/PartnersApi.md
CHANGED
|
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**confirm_partner_adapter_connection_0**](PartnersApi.md#confirm_partner_adapter_connection_0) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it |
|
|
7
8
|
| [**create_partner_extra_credits_invoice_0**](PartnersApi.md#create_partner_extra_credits_invoice_0) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner |
|
|
8
9
|
| [**get_my_partners_0**](PartnersApi.md#get_my_partners_0) | **GET** /partners/mine | Find the partner you administer |
|
|
9
10
|
| [**get_partner_adapter_connections_0**](PartnersApi.md#get_partner_adapter_connections_0) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected |
|
|
@@ -24,10 +25,12 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
24
25
|
| [**list_partner_notification_deliveries_0**](PartnersApi.md#list_partner_notification_deliveries_0) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you |
|
|
25
26
|
| [**list_partner_notifications_0**](PartnersApi.md#list_partner_notifications_0) | **GET** /partners/{partnerId}/notifications | What your partner account was told |
|
|
26
27
|
| [**list_partner_presets_0**](PartnersApi.md#list_partner_presets_0) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets |
|
|
28
|
+
| [**list_partner_workflow_presets_0**](PartnersApi.md#list_partner_workflow_presets_0) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start |
|
|
27
29
|
| [**remove_partner_adapter_connection_0**](PartnersApi.md#remove_partner_adapter_connection_0) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner |
|
|
28
30
|
| [**remove_partner_data_database_0**](PartnersApi.md#remove_partner_data_database_0) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database |
|
|
29
31
|
| [**remove_partner_preset_0**](PartnersApi.md#remove_partner_preset_0) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets |
|
|
30
32
|
| [**remove_partner_storage_destination_0**](PartnersApi.md#remove_partner_storage_destination_0) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket |
|
|
33
|
+
| [**remove_partner_workflow_preset_0**](PartnersApi.md#remove_partner_workflow_preset_0) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start |
|
|
31
34
|
| [**replay_partner_notification_delivery_0**](PartnersApi.md#replay_partner_notification_delivery_0) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again |
|
|
32
35
|
| [**rotate_partner_entry_context_secret_0**](PartnersApi.md#rotate_partner_entry_context_secret_0) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds |
|
|
33
36
|
| [**rotate_partner_webhook_secret_0**](PartnersApi.md#rotate_partner_webhook_secret_0) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook |
|
|
@@ -37,19 +40,95 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
37
40
|
| [**set_partner_design_defaults_0**](PartnersApi.md#set_partner_design_defaults_0) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults |
|
|
38
41
|
| [**set_partner_preset_0**](PartnersApi.md#set_partner_preset_0) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset |
|
|
39
42
|
| [**set_partner_storage_destination_0**](PartnersApi.md#set_partner_storage_destination_0) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored |
|
|
43
|
+
| [**set_partner_workflow_preset_0**](PartnersApi.md#set_partner_workflow_preset_0) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers |
|
|
40
44
|
| [**update_partner_entry_context_signing_0**](PartnersApi.md#update_partner_entry_context_signing_0) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it |
|
|
41
45
|
| [**update_partner_notification_settings_0**](PartnersApi.md#update_partner_notification_settings_0) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go |
|
|
42
46
|
| [**verify_partner_data_database_0**](PartnersApi.md#verify_partner_data_database_0) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works |
|
|
43
47
|
| [**verify_partner_storage_destination_0**](PartnersApi.md#verify_partner_storage_destination_0) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works |
|
|
44
48
|
|
|
45
49
|
|
|
50
|
+
## confirm_partner_adapter_connection_0
|
|
51
|
+
|
|
52
|
+
> <SetUserAdapterConnection200Response> confirm_partner_adapter_connection_0(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_0(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_0: #{e}"
|
|
81
|
+
end
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
#### Using the confirm_partner_adapter_connection_0_with_http_info variant
|
|
85
|
+
|
|
86
|
+
This returns an Array which contains the response data, status code and headers.
|
|
87
|
+
|
|
88
|
+
> <Array(<SetUserAdapterConnection200Response>, Integer, Hash)> confirm_partner_adapter_connection_0_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_0_with_http_info(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
94
|
+
p status_code # => 2xx
|
|
95
|
+
p headers # => { ... }
|
|
96
|
+
p data # => <SetUserAdapterConnection200Response>
|
|
97
|
+
rescue ApiSdkRb::ApiError => e
|
|
98
|
+
puts "Error when calling PartnersApi->confirm_partner_adapter_connection_0_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
|
+
[**SetUserAdapterConnection200Response**](SetUserAdapterConnection200Response.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
|
+
|
|
46
125
|
## create_partner_extra_credits_invoice_0
|
|
47
126
|
|
|
48
127
|
> <PartnerExtraCreditsInvoiceResponse> create_partner_extra_credits_invoice_0(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
|
|
|
@@ -1488,6 +1567,75 @@ end
|
|
|
1488
1567
|
- **Accept**: application/json
|
|
1489
1568
|
|
|
1490
1569
|
|
|
1570
|
+
## list_partner_workflow_presets_0
|
|
1571
|
+
|
|
1572
|
+
> <ListPartnerWorkflowPresets200Response> list_partner_workflow_presets_0(partner_id)
|
|
1573
|
+
|
|
1574
|
+
List the workflows a partner offers as places to start
|
|
1575
|
+
|
|
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_0(partner_id)
|
|
1595
|
+
p result
|
|
1596
|
+
rescue ApiSdkRb::ApiError => e
|
|
1597
|
+
puts "Error when calling PartnersApi->list_partner_workflow_presets_0: #{e}"
|
|
1598
|
+
end
|
|
1599
|
+
```
|
|
1600
|
+
|
|
1601
|
+
#### Using the list_partner_workflow_presets_0_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_0_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_0_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_0_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
|
+
|
|
1491
1639
|
## remove_partner_adapter_connection_0
|
|
1492
1640
|
|
|
1493
1641
|
> <RemoveUserAdapterConnection200Response> remove_partner_adapter_connection_0(partner_id, adapter_id, credential_key)
|
|
@@ -1770,6 +1918,77 @@ end
|
|
|
1770
1918
|
- **Accept**: application/json
|
|
1771
1919
|
|
|
1772
1920
|
|
|
1921
|
+
## remove_partner_workflow_preset_0
|
|
1922
|
+
|
|
1923
|
+
> <RemovePartnerWorkflowPreset200Response> remove_partner_workflow_preset_0(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_0(partner_id, key)
|
|
1947
|
+
p result
|
|
1948
|
+
rescue ApiSdkRb::ApiError => e
|
|
1949
|
+
puts "Error when calling PartnersApi->remove_partner_workflow_preset_0: #{e}"
|
|
1950
|
+
end
|
|
1951
|
+
```
|
|
1952
|
+
|
|
1953
|
+
#### Using the remove_partner_workflow_preset_0_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_0_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_0_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_0_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
|
+
|
|
1773
1992
|
## replay_partner_notification_delivery_0
|
|
1774
1993
|
|
|
1775
1994
|
> <PartnerNotificationDeliveryResponse> replay_partner_notification_delivery_0(partner_id, delivery_id, idempotency_key)
|
|
@@ -2064,7 +2283,7 @@ end
|
|
|
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
|
|
|
@@ -2419,6 +2638,79 @@ end
|
|
|
2419
2638
|
- **Accept**: application/json
|
|
2420
2639
|
|
|
2421
2640
|
|
|
2641
|
+
## set_partner_workflow_preset_0
|
|
2642
|
+
|
|
2643
|
+
> <SetPartnerWorkflowPreset200Response> set_partner_workflow_preset_0(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_0(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_0: #{e}"
|
|
2671
|
+
end
|
|
2672
|
+
```
|
|
2673
|
+
|
|
2674
|
+
#### Using the set_partner_workflow_preset_0_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_0_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_0_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_0_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
|
+
|
|
2422
2714
|
## update_partner_entry_context_signing_0
|
|
2423
2715
|
|
|
2424
2716
|
> <PartnerEntryContextSigningResponse> update_partner_entry_context_signing_0(partner_id, update_partner_entry_context_signing_request, opts)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::PatchBrandKitAssetRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Icon rename | [optional] |
|
|
8
|
+
| **family** | **String** | Font family relabel | [optional] |
|
|
9
|
+
| **weight** | **Integer** | | [optional] |
|
|
10
|
+
| **style** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::PatchBrandKitAssetRequest.new(
|
|
18
|
+
name: null,
|
|
19
|
+
family: null,
|
|
20
|
+
weight: null,
|
|
21
|
+
style: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ApiSdkRb::PatchBrandKitRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **colors** | [**Array<BrandColor>**](BrandColor.md) | The whole list of colors (it replaces the saved list). | [optional] |
|
|
8
|
+
| **fonts** | [**PatchBrandKitRequestFonts**](PatchBrandKitRequestFonts.md) | | [optional] |
|
|
9
|
+
| **spacing** | [**PatchBrandKitRequestSpacing**](PatchBrandKitRequestSpacing.md) | | [optional] |
|
|
10
|
+
| **corner_radius** | **Integer** | One corner radius in pixels for the whole kit; the small, medium and large radii are made from it. 0 gives square corners. A radius step sent in `spacing` wins over the one made from this value. | [optional] |
|
|
11
|
+
| **instructions** | **String** | The kit owner's style notes (see `tokens.instructions`). An empty string removes them. | [optional] |
|
|
12
|
+
| **expected_version** | **Integer** | Refuse the change with a 409 when the kit was saved again since this version was read. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'api-sdk-rb'
|
|
18
|
+
|
|
19
|
+
instance = ApiSdkRb::PatchBrandKitRequest.new(
|
|
20
|
+
colors: null,
|
|
21
|
+
fonts: null,
|
|
22
|
+
spacing: null,
|
|
23
|
+
corner_radius: null,
|
|
24
|
+
instructions: null,
|
|
25
|
+
expected_version: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::PatchBrandKitRequestFonts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | [**BrandFont**](BrandFont.md) | | [optional] |
|
|
8
|
+
| **subtitle** | [**BrandFont**](BrandFont.md) | | [optional] |
|
|
9
|
+
| **body** | [**BrandFont**](BrandFont.md) | | [optional] |
|
|
10
|
+
| **caption** | [**BrandFont**](BrandFont.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::PatchBrandKitRequestFonts.new(
|
|
18
|
+
title: null,
|
|
19
|
+
subtitle: null,
|
|
20
|
+
body: null,
|
|
21
|
+
caption: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ApiSdkRb::PatchBrandKitRequestSpacing
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **xs** | **Integer** | | [optional] |
|
|
8
|
+
| **s** | **Integer** | | [optional] |
|
|
9
|
+
| **m** | **Integer** | | [optional] |
|
|
10
|
+
| **l** | **Integer** | | [optional] |
|
|
11
|
+
| **xl** | **Integer** | | [optional] |
|
|
12
|
+
| **radius_s** | **Integer** | | [optional] |
|
|
13
|
+
| **radius_m** | **Integer** | | [optional] |
|
|
14
|
+
| **radius_l** | **Integer** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'api-sdk-rb'
|
|
20
|
+
|
|
21
|
+
instance = ApiSdkRb::PatchBrandKitRequestSpacing.new(
|
|
22
|
+
xs: null,
|
|
23
|
+
s: null,
|
|
24
|
+
m: null,
|
|
25
|
+
l: null,
|
|
26
|
+
xl: null,
|
|
27
|
+
radius_s: null,
|
|
28
|
+
radius_m: null,
|
|
29
|
+
radius_l: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::PostBrandKitIconRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **svg** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::PostBrandKitIconRequest.new(
|
|
16
|
+
name: null,
|
|
17
|
+
svg: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|