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
data/docs/BrandKitApi.md
ADDED
|
@@ -0,0 +1,593 @@
|
|
|
1
|
+
# ApiSdkRb::BrandKitApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.widgetic.com/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**delete_brand_kit_0**](BrandKitApi.md#delete_brand_kit_0) | **DELETE** /brand-kit | Reset the Brand Kit to the default |
|
|
8
|
+
| [**delete_brand_kit_asset_0**](BrandKitApi.md#delete_brand_kit_asset_0) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit |
|
|
9
|
+
| [**get_brand_kit_0**](BrandKitApi.md#get_brand_kit_0) | **GET** /brand-kit | The Brand Kit of the current workspace |
|
|
10
|
+
| [**patch_brand_kit_0**](BrandKitApi.md#patch_brand_kit_0) | **PATCH** /brand-kit | Change part of the Brand Kit |
|
|
11
|
+
| [**patch_brand_kit_asset_0**](BrandKitApi.md#patch_brand_kit_asset_0) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant |
|
|
12
|
+
| [**post_brand_kit_font_0**](BrandKitApi.md#post_brand_kit_font_0) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit |
|
|
13
|
+
| [**post_brand_kit_icon_0**](BrandKitApi.md#post_brand_kit_icon_0) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit |
|
|
14
|
+
| [**put_brand_kit_0**](BrandKitApi.md#put_brand_kit_0) | **PUT** /brand-kit | Save Brand Kit tokens |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## delete_brand_kit_0
|
|
18
|
+
|
|
19
|
+
> <BrandKitViewResponse> delete_brand_kit_0(opts)
|
|
20
|
+
|
|
21
|
+
Reset the Brand Kit to the default
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'time'
|
|
27
|
+
require 'api-sdk-rb'
|
|
28
|
+
# setup authorization
|
|
29
|
+
ApiSdkRb.configure do |config|
|
|
30
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
35
|
+
opts = {
|
|
36
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Reset the Brand Kit to the default
|
|
41
|
+
result = api_instance.delete_brand_kit_0(opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue ApiSdkRb::ApiError => e
|
|
44
|
+
puts "Error when calling BrandKitApi->delete_brand_kit_0: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the delete_brand_kit_0_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_0_with_http_info(opts)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# Reset the Brand Kit to the default
|
|
57
|
+
data, status_code, headers = api_instance.delete_brand_kit_0_with_http_info(opts)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <BrandKitViewResponse>
|
|
61
|
+
rescue ApiSdkRb::ApiError => e
|
|
62
|
+
puts "Error when calling BrandKitApi->delete_brand_kit_0_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **organization_id** | **String** | | [optional] |
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
75
|
+
|
|
76
|
+
### Authorization
|
|
77
|
+
|
|
78
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
79
|
+
|
|
80
|
+
### HTTP request headers
|
|
81
|
+
|
|
82
|
+
- **Content-Type**: Not defined
|
|
83
|
+
- **Accept**: application/json
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## delete_brand_kit_asset_0
|
|
87
|
+
|
|
88
|
+
> <BrandKitViewResponse> delete_brand_kit_asset_0(asset_id, opts)
|
|
89
|
+
|
|
90
|
+
Remove a font or icon from the Brand Kit
|
|
91
|
+
|
|
92
|
+
### Examples
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
require 'time'
|
|
96
|
+
require 'api-sdk-rb'
|
|
97
|
+
# setup authorization
|
|
98
|
+
ApiSdkRb.configure do |config|
|
|
99
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
100
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
104
|
+
asset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
105
|
+
opts = {
|
|
106
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
# Remove a font or icon from the Brand Kit
|
|
111
|
+
result = api_instance.delete_brand_kit_asset_0(asset_id, opts)
|
|
112
|
+
p result
|
|
113
|
+
rescue ApiSdkRb::ApiError => e
|
|
114
|
+
puts "Error when calling BrandKitApi->delete_brand_kit_asset_0: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the delete_brand_kit_asset_0_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_asset_0_with_http_info(asset_id, opts)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# Remove a font or icon from the Brand Kit
|
|
127
|
+
data, status_code, headers = api_instance.delete_brand_kit_asset_0_with_http_info(asset_id, opts)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => <BrandKitViewResponse>
|
|
131
|
+
rescue ApiSdkRb::ApiError => e
|
|
132
|
+
puts "Error when calling BrandKitApi->delete_brand_kit_asset_0_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **asset_id** | **String** | | |
|
|
141
|
+
| **organization_id** | **String** | | [optional] |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: Not defined
|
|
154
|
+
- **Accept**: application/json
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## get_brand_kit_0
|
|
158
|
+
|
|
159
|
+
> <BrandKitViewResponse> get_brand_kit_0(opts)
|
|
160
|
+
|
|
161
|
+
The Brand Kit of the current workspace
|
|
162
|
+
|
|
163
|
+
The colors, fonts, icons, corner radius and style notes every widget made by this account is generated with. An account that never saved a kit gets Widgetic's default one (`isDefault` is true). A partner account's kit is the default for everything its keys create, and a key reads and changes the kit of the account it belongs to; there is no kit per managed user.
|
|
164
|
+
|
|
165
|
+
### Examples
|
|
166
|
+
|
|
167
|
+
```ruby
|
|
168
|
+
require 'time'
|
|
169
|
+
require 'api-sdk-rb'
|
|
170
|
+
# setup authorization
|
|
171
|
+
ApiSdkRb.configure do |config|
|
|
172
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
173
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
177
|
+
opts = {
|
|
178
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | An organisation's kit; omit for the caller's current workspace.
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
begin
|
|
182
|
+
# The Brand Kit of the current workspace
|
|
183
|
+
result = api_instance.get_brand_kit_0(opts)
|
|
184
|
+
p result
|
|
185
|
+
rescue ApiSdkRb::ApiError => e
|
|
186
|
+
puts "Error when calling BrandKitApi->get_brand_kit_0: #{e}"
|
|
187
|
+
end
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
#### Using the get_brand_kit_0_with_http_info variant
|
|
191
|
+
|
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
|
193
|
+
|
|
194
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> get_brand_kit_0_with_http_info(opts)
|
|
195
|
+
|
|
196
|
+
```ruby
|
|
197
|
+
begin
|
|
198
|
+
# The Brand Kit of the current workspace
|
|
199
|
+
data, status_code, headers = api_instance.get_brand_kit_0_with_http_info(opts)
|
|
200
|
+
p status_code # => 2xx
|
|
201
|
+
p headers # => { ... }
|
|
202
|
+
p data # => <BrandKitViewResponse>
|
|
203
|
+
rescue ApiSdkRb::ApiError => e
|
|
204
|
+
puts "Error when calling BrandKitApi->get_brand_kit_0_with_http_info: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
| Name | Type | Description | Notes |
|
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
|
212
|
+
| **organization_id** | **String** | An organisation's kit; omit for the caller's current workspace. | [optional] |
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: Not defined
|
|
225
|
+
- **Accept**: application/json
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
## patch_brand_kit_0
|
|
229
|
+
|
|
230
|
+
> <BrandKitViewResponse> patch_brand_kit_0(patch_brand_kit_request, opts)
|
|
231
|
+
|
|
232
|
+
Change part of the Brand Kit
|
|
233
|
+
|
|
234
|
+
Changes only what is sent: the colors, a font role, a spacing step, one corner radius (0 for square corners) or the style notes, and keeps the rest of the saved kit. An account that never saved a kit starts from Widgetic's default one. The response lists what is worth fixing in `warnings`.
|
|
235
|
+
|
|
236
|
+
### Examples
|
|
237
|
+
|
|
238
|
+
```ruby
|
|
239
|
+
require 'time'
|
|
240
|
+
require 'api-sdk-rb'
|
|
241
|
+
# setup authorization
|
|
242
|
+
ApiSdkRb.configure do |config|
|
|
243
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
244
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
248
|
+
patch_brand_kit_request = ApiSdkRb::PatchBrandKitRequest.new # PatchBrandKitRequest |
|
|
249
|
+
opts = {
|
|
250
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
begin
|
|
254
|
+
# Change part of the Brand Kit
|
|
255
|
+
result = api_instance.patch_brand_kit_0(patch_brand_kit_request, opts)
|
|
256
|
+
p result
|
|
257
|
+
rescue ApiSdkRb::ApiError => e
|
|
258
|
+
puts "Error when calling BrandKitApi->patch_brand_kit_0: #{e}"
|
|
259
|
+
end
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
#### Using the patch_brand_kit_0_with_http_info variant
|
|
263
|
+
|
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
|
265
|
+
|
|
266
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_0_with_http_info(patch_brand_kit_request, opts)
|
|
267
|
+
|
|
268
|
+
```ruby
|
|
269
|
+
begin
|
|
270
|
+
# Change part of the Brand Kit
|
|
271
|
+
data, status_code, headers = api_instance.patch_brand_kit_0_with_http_info(patch_brand_kit_request, opts)
|
|
272
|
+
p status_code # => 2xx
|
|
273
|
+
p headers # => { ... }
|
|
274
|
+
p data # => <BrandKitViewResponse>
|
|
275
|
+
rescue ApiSdkRb::ApiError => e
|
|
276
|
+
puts "Error when calling BrandKitApi->patch_brand_kit_0_with_http_info: #{e}"
|
|
277
|
+
end
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
### Parameters
|
|
281
|
+
|
|
282
|
+
| Name | Type | Description | Notes |
|
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
|
284
|
+
| **patch_brand_kit_request** | [**PatchBrandKitRequest**](PatchBrandKitRequest.md) | | |
|
|
285
|
+
| **organization_id** | **String** | | [optional] |
|
|
286
|
+
|
|
287
|
+
### Return type
|
|
288
|
+
|
|
289
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
290
|
+
|
|
291
|
+
### Authorization
|
|
292
|
+
|
|
293
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
294
|
+
|
|
295
|
+
### HTTP request headers
|
|
296
|
+
|
|
297
|
+
- **Content-Type**: application/json
|
|
298
|
+
- **Accept**: application/json
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
## patch_brand_kit_asset_0
|
|
302
|
+
|
|
303
|
+
> <BrandKitViewResponse> patch_brand_kit_asset_0(asset_id, patch_brand_kit_asset_request, opts)
|
|
304
|
+
|
|
305
|
+
Rename an icon or relabel a font variant
|
|
306
|
+
|
|
307
|
+
### Examples
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
require 'time'
|
|
311
|
+
require 'api-sdk-rb'
|
|
312
|
+
# setup authorization
|
|
313
|
+
ApiSdkRb.configure do |config|
|
|
314
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
315
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
319
|
+
asset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
320
|
+
patch_brand_kit_asset_request = ApiSdkRb::PatchBrandKitAssetRequest.new # PatchBrandKitAssetRequest |
|
|
321
|
+
opts = {
|
|
322
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
begin
|
|
326
|
+
# Rename an icon or relabel a font variant
|
|
327
|
+
result = api_instance.patch_brand_kit_asset_0(asset_id, patch_brand_kit_asset_request, opts)
|
|
328
|
+
p result
|
|
329
|
+
rescue ApiSdkRb::ApiError => e
|
|
330
|
+
puts "Error when calling BrandKitApi->patch_brand_kit_asset_0: #{e}"
|
|
331
|
+
end
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
#### Using the patch_brand_kit_asset_0_with_http_info variant
|
|
335
|
+
|
|
336
|
+
This returns an Array which contains the response data, status code and headers.
|
|
337
|
+
|
|
338
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_asset_0_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
|
|
339
|
+
|
|
340
|
+
```ruby
|
|
341
|
+
begin
|
|
342
|
+
# Rename an icon or relabel a font variant
|
|
343
|
+
data, status_code, headers = api_instance.patch_brand_kit_asset_0_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
|
|
344
|
+
p status_code # => 2xx
|
|
345
|
+
p headers # => { ... }
|
|
346
|
+
p data # => <BrandKitViewResponse>
|
|
347
|
+
rescue ApiSdkRb::ApiError => e
|
|
348
|
+
puts "Error when calling BrandKitApi->patch_brand_kit_asset_0_with_http_info: #{e}"
|
|
349
|
+
end
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
### Parameters
|
|
353
|
+
|
|
354
|
+
| Name | Type | Description | Notes |
|
|
355
|
+
| ---- | ---- | ----------- | ----- |
|
|
356
|
+
| **asset_id** | **String** | | |
|
|
357
|
+
| **patch_brand_kit_asset_request** | [**PatchBrandKitAssetRequest**](PatchBrandKitAssetRequest.md) | | |
|
|
358
|
+
| **organization_id** | **String** | | [optional] |
|
|
359
|
+
|
|
360
|
+
### Return type
|
|
361
|
+
|
|
362
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
363
|
+
|
|
364
|
+
### Authorization
|
|
365
|
+
|
|
366
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
367
|
+
|
|
368
|
+
### HTTP request headers
|
|
369
|
+
|
|
370
|
+
- **Content-Type**: application/json
|
|
371
|
+
- **Accept**: application/json
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
## post_brand_kit_font_0
|
|
375
|
+
|
|
376
|
+
> <BrandKitViewResponse> post_brand_kit_font_0(file, family, weight, opts)
|
|
377
|
+
|
|
378
|
+
Upload a font file to the Brand Kit
|
|
379
|
+
|
|
380
|
+
### Examples
|
|
381
|
+
|
|
382
|
+
```ruby
|
|
383
|
+
require 'time'
|
|
384
|
+
require 'api-sdk-rb'
|
|
385
|
+
# setup authorization
|
|
386
|
+
ApiSdkRb.configure do |config|
|
|
387
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
388
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
392
|
+
file = File.new('/path/to/some/file') # File |
|
|
393
|
+
family = 'family_example' # String |
|
|
394
|
+
weight = 56 # Integer |
|
|
395
|
+
opts = {
|
|
396
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String |
|
|
397
|
+
style: 'normal' # String |
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
begin
|
|
401
|
+
# Upload a font file to the Brand Kit
|
|
402
|
+
result = api_instance.post_brand_kit_font_0(file, family, weight, opts)
|
|
403
|
+
p result
|
|
404
|
+
rescue ApiSdkRb::ApiError => e
|
|
405
|
+
puts "Error when calling BrandKitApi->post_brand_kit_font_0: #{e}"
|
|
406
|
+
end
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
#### Using the post_brand_kit_font_0_with_http_info variant
|
|
410
|
+
|
|
411
|
+
This returns an Array which contains the response data, status code and headers.
|
|
412
|
+
|
|
413
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_font_0_with_http_info(file, family, weight, opts)
|
|
414
|
+
|
|
415
|
+
```ruby
|
|
416
|
+
begin
|
|
417
|
+
# Upload a font file to the Brand Kit
|
|
418
|
+
data, status_code, headers = api_instance.post_brand_kit_font_0_with_http_info(file, family, weight, opts)
|
|
419
|
+
p status_code # => 2xx
|
|
420
|
+
p headers # => { ... }
|
|
421
|
+
p data # => <BrandKitViewResponse>
|
|
422
|
+
rescue ApiSdkRb::ApiError => e
|
|
423
|
+
puts "Error when calling BrandKitApi->post_brand_kit_font_0_with_http_info: #{e}"
|
|
424
|
+
end
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Parameters
|
|
428
|
+
|
|
429
|
+
| Name | Type | Description | Notes |
|
|
430
|
+
| ---- | ---- | ----------- | ----- |
|
|
431
|
+
| **file** | **File** | | |
|
|
432
|
+
| **family** | **String** | | |
|
|
433
|
+
| **weight** | **Integer** | | |
|
|
434
|
+
| **organization_id** | **String** | | [optional] |
|
|
435
|
+
| **style** | **String** | | [optional] |
|
|
436
|
+
|
|
437
|
+
### Return type
|
|
438
|
+
|
|
439
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
440
|
+
|
|
441
|
+
### Authorization
|
|
442
|
+
|
|
443
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
444
|
+
|
|
445
|
+
### HTTP request headers
|
|
446
|
+
|
|
447
|
+
- **Content-Type**: multipart/form-data
|
|
448
|
+
- **Accept**: application/json
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
## post_brand_kit_icon_0
|
|
452
|
+
|
|
453
|
+
> <BrandKitViewResponse> post_brand_kit_icon_0(post_brand_kit_icon_request, opts)
|
|
454
|
+
|
|
455
|
+
Add a named SVG icon to the Brand Kit
|
|
456
|
+
|
|
457
|
+
### Examples
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
require 'time'
|
|
461
|
+
require 'api-sdk-rb'
|
|
462
|
+
# setup authorization
|
|
463
|
+
ApiSdkRb.configure do |config|
|
|
464
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
465
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
469
|
+
post_brand_kit_icon_request = ApiSdkRb::PostBrandKitIconRequest.new({name: 'name_example', svg: 'svg_example'}) # PostBrandKitIconRequest |
|
|
470
|
+
opts = {
|
|
471
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
begin
|
|
475
|
+
# Add a named SVG icon to the Brand Kit
|
|
476
|
+
result = api_instance.post_brand_kit_icon_0(post_brand_kit_icon_request, opts)
|
|
477
|
+
p result
|
|
478
|
+
rescue ApiSdkRb::ApiError => e
|
|
479
|
+
puts "Error when calling BrandKitApi->post_brand_kit_icon_0: #{e}"
|
|
480
|
+
end
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
#### Using the post_brand_kit_icon_0_with_http_info variant
|
|
484
|
+
|
|
485
|
+
This returns an Array which contains the response data, status code and headers.
|
|
486
|
+
|
|
487
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_icon_0_with_http_info(post_brand_kit_icon_request, opts)
|
|
488
|
+
|
|
489
|
+
```ruby
|
|
490
|
+
begin
|
|
491
|
+
# Add a named SVG icon to the Brand Kit
|
|
492
|
+
data, status_code, headers = api_instance.post_brand_kit_icon_0_with_http_info(post_brand_kit_icon_request, opts)
|
|
493
|
+
p status_code # => 2xx
|
|
494
|
+
p headers # => { ... }
|
|
495
|
+
p data # => <BrandKitViewResponse>
|
|
496
|
+
rescue ApiSdkRb::ApiError => e
|
|
497
|
+
puts "Error when calling BrandKitApi->post_brand_kit_icon_0_with_http_info: #{e}"
|
|
498
|
+
end
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
| Name | Type | Description | Notes |
|
|
504
|
+
| ---- | ---- | ----------- | ----- |
|
|
505
|
+
| **post_brand_kit_icon_request** | [**PostBrandKitIconRequest**](PostBrandKitIconRequest.md) | | |
|
|
506
|
+
| **organization_id** | **String** | | [optional] |
|
|
507
|
+
|
|
508
|
+
### Return type
|
|
509
|
+
|
|
510
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
511
|
+
|
|
512
|
+
### Authorization
|
|
513
|
+
|
|
514
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
515
|
+
|
|
516
|
+
### HTTP request headers
|
|
517
|
+
|
|
518
|
+
- **Content-Type**: application/json
|
|
519
|
+
- **Accept**: application/json
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
## put_brand_kit_0
|
|
523
|
+
|
|
524
|
+
> <BrandKitViewResponse> put_brand_kit_0(put_brand_kit_request, opts)
|
|
525
|
+
|
|
526
|
+
Save Brand Kit tokens
|
|
527
|
+
|
|
528
|
+
Replaces the colors, fonts, spacing and notes of the kit with the ones sent. To change one thing, use PATCH.
|
|
529
|
+
|
|
530
|
+
### Examples
|
|
531
|
+
|
|
532
|
+
```ruby
|
|
533
|
+
require 'time'
|
|
534
|
+
require 'api-sdk-rb'
|
|
535
|
+
# setup authorization
|
|
536
|
+
ApiSdkRb.configure do |config|
|
|
537
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
538
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
539
|
+
end
|
|
540
|
+
|
|
541
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
542
|
+
put_brand_kit_request = ApiSdkRb::PutBrandKitRequest.new({tokens: ApiSdkRb::BrandKitTokens.new({colors: [ApiSdkRb::BrandColor.new({name: 'name_example', hex: 'hex_example'})], fonts: ApiSdkRb::BrandKitTokensFonts.new, spacing: ApiSdkRb::BrandSpacing.new({xs: 37, s: 37, m: 37, l: 37, xl: 37, radius_s: 37, radius_m: 37, radius_l: 37})})}) # PutBrandKitRequest |
|
|
543
|
+
opts = {
|
|
544
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
begin
|
|
548
|
+
# Save Brand Kit tokens
|
|
549
|
+
result = api_instance.put_brand_kit_0(put_brand_kit_request, opts)
|
|
550
|
+
p result
|
|
551
|
+
rescue ApiSdkRb::ApiError => e
|
|
552
|
+
puts "Error when calling BrandKitApi->put_brand_kit_0: #{e}"
|
|
553
|
+
end
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
#### Using the put_brand_kit_0_with_http_info variant
|
|
557
|
+
|
|
558
|
+
This returns an Array which contains the response data, status code and headers.
|
|
559
|
+
|
|
560
|
+
> <Array(<BrandKitViewResponse>, Integer, Hash)> put_brand_kit_0_with_http_info(put_brand_kit_request, opts)
|
|
561
|
+
|
|
562
|
+
```ruby
|
|
563
|
+
begin
|
|
564
|
+
# Save Brand Kit tokens
|
|
565
|
+
data, status_code, headers = api_instance.put_brand_kit_0_with_http_info(put_brand_kit_request, opts)
|
|
566
|
+
p status_code # => 2xx
|
|
567
|
+
p headers # => { ... }
|
|
568
|
+
p data # => <BrandKitViewResponse>
|
|
569
|
+
rescue ApiSdkRb::ApiError => e
|
|
570
|
+
puts "Error when calling BrandKitApi->put_brand_kit_0_with_http_info: #{e}"
|
|
571
|
+
end
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
### Parameters
|
|
575
|
+
|
|
576
|
+
| Name | Type | Description | Notes |
|
|
577
|
+
| ---- | ---- | ----------- | ----- |
|
|
578
|
+
| **put_brand_kit_request** | [**PutBrandKitRequest**](PutBrandKitRequest.md) | | |
|
|
579
|
+
| **organization_id** | **String** | | [optional] |
|
|
580
|
+
|
|
581
|
+
### Return type
|
|
582
|
+
|
|
583
|
+
[**BrandKitViewResponse**](BrandKitViewResponse.md)
|
|
584
|
+
|
|
585
|
+
### Authorization
|
|
586
|
+
|
|
587
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
588
|
+
|
|
589
|
+
### HTTP request headers
|
|
590
|
+
|
|
591
|
+
- **Content-Type**: application/json
|
|
592
|
+
- **Accept**: application/json
|
|
593
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# ApiSdkRb::BrandKitAssetView
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **kind** | **String** | | |
|
|
9
|
+
| **name** | **String** | | |
|
|
10
|
+
| **created_at** | **Time** | | |
|
|
11
|
+
| **family** | **String** | | [optional] |
|
|
12
|
+
| **weight** | **Integer** | | [optional] |
|
|
13
|
+
| **style** | **String** | | [optional] |
|
|
14
|
+
| **format** | **String** | | [optional] |
|
|
15
|
+
| **bytes** | **Integer** | | [optional] |
|
|
16
|
+
| **url** | **String** | | [optional] |
|
|
17
|
+
| **slug** | **String** | | [optional] |
|
|
18
|
+
| **export_name** | **String** | | [optional] |
|
|
19
|
+
| **svg** | **String** | | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'api-sdk-rb'
|
|
25
|
+
|
|
26
|
+
instance = ApiSdkRb::BrandKitAssetView.new(
|
|
27
|
+
id: null,
|
|
28
|
+
kind: null,
|
|
29
|
+
name: null,
|
|
30
|
+
created_at: null,
|
|
31
|
+
family: null,
|
|
32
|
+
weight: null,
|
|
33
|
+
style: null,
|
|
34
|
+
format: null,
|
|
35
|
+
bytes: null,
|
|
36
|
+
url: null,
|
|
37
|
+
slug: null,
|
|
38
|
+
export_name: null,
|
|
39
|
+
svg: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ApiSdkRb::BrandKitFigmaSource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | |
|
|
8
|
+
| **file_key** | **String** | | |
|
|
9
|
+
| **node_id** | **String** | | |
|
|
10
|
+
| **file_name** | **String** | | |
|
|
11
|
+
| **imported_at** | **Time** | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'api-sdk-rb'
|
|
17
|
+
|
|
18
|
+
instance = ApiSdkRb::BrandKitFigmaSource.new(
|
|
19
|
+
url: null,
|
|
20
|
+
file_key: null,
|
|
21
|
+
node_id: null,
|
|
22
|
+
file_name: null,
|
|
23
|
+
imported_at: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::BrandKitTokens
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **colors** | [**Array<BrandColor>**](BrandColor.md) | | |
|
|
8
|
+
| **fonts** | [**BrandKitTokensFonts**](BrandKitTokensFonts.md) | | |
|
|
9
|
+
| **spacing** | [**BrandSpacing**](BrandSpacing.md) | | |
|
|
10
|
+
| **instructions** | **String** | The kit owner's own style notes, taken into account in every widget made with the kit, for example \"Use the dark color as the background always and the light color for titles\". They are about how a widget looks and never about what it holds, and what a request names itself wins over them. Left out, Widgetic's default note applies (\"Widget backgrounds to be white whenever possible.\"); an empty string means none. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::BrandKitTokens.new(
|
|
18
|
+
colors: null,
|
|
19
|
+
fonts: null,
|
|
20
|
+
spacing: null,
|
|
21
|
+
instructions: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::BrandKitTokensFonts
|
|
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::BrandKitTokensFonts.new(
|
|
18
|
+
title: null,
|
|
19
|
+
subtitle: null,
|
|
20
|
+
body: null,
|
|
21
|
+
caption: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|