api-sdk-rb 1.11.111 → 1.11.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +207 -381
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandKitApi.md +74 -74
- data/docs/BrandKitTokens.md +2 -0
- data/docs/BrandKitView.md +1 -1
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionsApi.md +615 -349
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreditsApi.md +20 -20
- data/docs/{CreateCompositionFromWidget201Response.md → DeleteUpload200Response.md} +3 -3
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/{OperationsIdGetResponse.md → GetOperationResponse.md} +3 -3
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnersApi.md +388 -388
- data/docs/PatchBrandKitRequest.md +2 -0
- data/docs/PublicEmbedApi.md +95 -95
- data/docs/PublicWorkflowEventsRequestEventsInner.md +3 -1
- data/docs/{GetPublicWorkflow200Response.md → PublicWorkflowResponse.md} +2 -2
- data/docs/TokensApi.md +11 -9
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +125 -125
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md} +2 -2
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md} +2 -2
- data/docs/WorkflowStats.md +4 -2
- data/docs/WorkflowsApi.md +197 -413
- data/lib/api-sdk-rb/api/brand_kit_api.rb +61 -61
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +770 -441
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +389 -389
- data/lib/api-sdk-rb/api/public_embed_api.rb +95 -95
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +132 -132
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +246 -468
- data/lib/api-sdk-rb/configuration.rb +0 -60
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{save_workspace_workflow200_response.rb → adapter_connection_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → adapter_connection_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → ai_answers_knowledge_document_response.rb} +3 -3
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +33 -2
- data/lib/api-sdk-rb/models/brand_kit_view.rb +1 -1
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → content_item_write_result_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → design_defaults_response.rb} +3 -3
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +32 -1
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +26 -4
- data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb} +3 -3
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → widget_clarification_option.rb} +40 -30
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/{create_workspace_workflow_from_preset201_response.rb → widget_plan_decisions_libraries_inner.rb} +39 -30
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → workflow_detail_response.rb} +4 -4
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +17 -5
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +32 -21
- data/spec/api/brand_kit_api_spec.rb +18 -18
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +144 -83
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +91 -91
- data/spec/api/public_embed_api_spec.rb +23 -23
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +30 -30
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +50 -89
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → account_credit_transaction_list_response_spec.rb} +6 -6
- data/spec/models/{get_public_workflow200_response_spec.rb → adapter_connection_list_response_spec.rb} +6 -6
- data/spec/models/{save_workspace_workflow200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_kit_tokens_spec.rb +6 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → brand_text_style_spec.rb} +13 -9
- data/spec/models/{get_managed_user_limits200_response_spec.rb → composition_database_record_response_spec.rb} +6 -6
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/{uploads_get200_response_spec.rb → get_operation_response_spec.rb} +6 -6
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/patch_brand_kit_request_spec.rb +6 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +10 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → widget_plan_spec.rb} +21 -9
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_stats_spec.rb +6 -0
- metadata +130 -86
- data/docs/PartnerApi.md +0 -12714
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/docs/WorkspacesApi.md +0 -1527
- data/lib/api-sdk-rb/api/partner_api.rb +0 -13791
- data/lib/api-sdk-rb/api/workspaces_api.rb +0 -1775
- data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +0 -246
- data/spec/api/partner_api_spec.rb +0 -2437
- data/spec/api/workspaces_api_spec.rb +0 -339
- data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +0 -48
- data/spec/models/create_composition_content_item201_response_spec.rb +0 -48
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +0 -48
- data/spec/models/get_partner_credit_transactions200_response_spec.rb +0 -48
- data/spec/models/get_partner_design_defaults200_response_spec.rb +0 -48
- data/spec/models/remove_user_adapter_connection200_response_spec.rb +0 -48
- data/spec/models/set_user_adapter_connection200_response_spec.rb +0 -48
data/docs/PartnersApi.md
CHANGED
|
@@ -4,52 +4,52 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**
|
|
31
|
-
| [**
|
|
32
|
-
| [**
|
|
33
|
-
| [**
|
|
34
|
-
| [**
|
|
35
|
-
| [**
|
|
36
|
-
| [**
|
|
37
|
-
| [**
|
|
38
|
-
| [**
|
|
39
|
-
| [**
|
|
40
|
-
| [**
|
|
41
|
-
| [**
|
|
42
|
-
| [**
|
|
43
|
-
| [**
|
|
44
|
-
| [**
|
|
45
|
-
| [**
|
|
46
|
-
| [**
|
|
47
|
-
| [**
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
##
|
|
51
|
-
|
|
52
|
-
> <
|
|
7
|
+
| [**confirm_partner_adapter_connection**](PartnersApi.md#confirm_partner_adapter_connection) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it |
|
|
8
|
+
| [**create_partner_extra_credits_invoice**](PartnersApi.md#create_partner_extra_credits_invoice) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner |
|
|
9
|
+
| [**get_my_partners**](PartnersApi.md#get_my_partners) | **GET** /partners/mine | Find the partner you administer |
|
|
10
|
+
| [**get_partner_adapter_connections**](PartnersApi.md#get_partner_adapter_connections) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected |
|
|
11
|
+
| [**get_partner_analytics_by_managed_user**](PartnersApi.md#get_partner_analytics_by_managed_user) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did |
|
|
12
|
+
| [**get_partner_analytics_summary**](PartnersApi.md#get_partner_analytics_summary) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets |
|
|
13
|
+
| [**get_partner_analytics_timeline**](PartnersApi.md#get_partner_analytics_timeline) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day |
|
|
14
|
+
| [**get_partner_analytics_top_widgets**](PartnersApi.md#get_partner_analytics_top_widgets) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most |
|
|
15
|
+
| [**get_partner_billing_overview**](PartnersApi.md#get_partner_billing_overview) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview |
|
|
16
|
+
| [**get_partner_contract**](PartnersApi.md#get_partner_contract) | **GET** /partners/{partnerId}/contract | Get a partner's contract |
|
|
17
|
+
| [**get_partner_credit_balance**](PartnersApi.md#get_partner_credit_balance) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance |
|
|
18
|
+
| [**get_partner_credit_transactions**](PartnersApi.md#get_partner_credit_transactions) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history |
|
|
19
|
+
| [**get_partner_data_database**](PartnersApi.md#get_partner_data_database) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in |
|
|
20
|
+
| [**get_partner_design_defaults**](PartnersApi.md#get_partner_design_defaults) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults |
|
|
21
|
+
| [**get_partner_entry_context_signing**](PartnersApi.md#get_partner_entry_context_signing) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed |
|
|
22
|
+
| [**get_partner_notification_settings**](PartnersApi.md#get_partner_notification_settings) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go |
|
|
23
|
+
| [**get_partner_storage_destination**](PartnersApi.md#get_partner_storage_destination) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored |
|
|
24
|
+
| [**get_partner_storage_usage**](PartnersApi.md#get_partner_storage_usage) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store |
|
|
25
|
+
| [**list_partner_notification_deliveries**](PartnersApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you |
|
|
26
|
+
| [**list_partner_notifications**](PartnersApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told |
|
|
27
|
+
| [**list_partner_presets**](PartnersApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets |
|
|
28
|
+
| [**list_partner_workflow_presets**](PartnersApi.md#list_partner_workflow_presets) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start |
|
|
29
|
+
| [**remove_partner_adapter_connection**](PartnersApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner |
|
|
30
|
+
| [**remove_partner_data_database**](PartnersApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database |
|
|
31
|
+
| [**remove_partner_preset**](PartnersApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets |
|
|
32
|
+
| [**remove_partner_storage_destination**](PartnersApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket |
|
|
33
|
+
| [**remove_partner_workflow_preset**](PartnersApi.md#remove_partner_workflow_preset) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start |
|
|
34
|
+
| [**replay_partner_notification_delivery**](PartnersApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again |
|
|
35
|
+
| [**rotate_partner_entry_context_secret**](PartnersApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds |
|
|
36
|
+
| [**rotate_partner_webhook_secret**](PartnersApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook |
|
|
37
|
+
| [**send_partner_notification_test_event**](PartnersApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook |
|
|
38
|
+
| [**set_partner_adapter_connection**](PartnersApi.md#set_partner_adapter_connection) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner |
|
|
39
|
+
| [**set_partner_data_database**](PartnersApi.md#set_partner_data_database) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own |
|
|
40
|
+
| [**set_partner_design_defaults**](PartnersApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults |
|
|
41
|
+
| [**set_partner_preset**](PartnersApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset |
|
|
42
|
+
| [**set_partner_storage_destination**](PartnersApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored |
|
|
43
|
+
| [**set_partner_workflow_preset**](PartnersApi.md#set_partner_workflow_preset) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers |
|
|
44
|
+
| [**update_partner_entry_context_signing**](PartnersApi.md#update_partner_entry_context_signing) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it |
|
|
45
|
+
| [**update_partner_notification_settings**](PartnersApi.md#update_partner_notification_settings) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go |
|
|
46
|
+
| [**verify_partner_data_database**](PartnersApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works |
|
|
47
|
+
| [**verify_partner_storage_destination**](PartnersApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works |
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
## confirm_partner_adapter_connection
|
|
51
|
+
|
|
52
|
+
> <AdapterConnectionResponse> confirm_partner_adapter_connection(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
53
53
|
|
|
54
54
|
Confirm a partner's adapter address with the code that was emailed to it
|
|
55
55
|
|
|
@@ -74,28 +74,28 @@ confirm_adapter_connection_request = ApiSdkRb::ConfirmAdapterConnectionRequest.n
|
|
|
74
74
|
|
|
75
75
|
begin
|
|
76
76
|
# Confirm a partner's adapter address with the code that was emailed to it
|
|
77
|
-
result = api_instance.
|
|
77
|
+
result = api_instance.confirm_partner_adapter_connection(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
78
78
|
p result
|
|
79
79
|
rescue ApiSdkRb::ApiError => e
|
|
80
|
-
puts "Error when calling PartnersApi->
|
|
80
|
+
puts "Error when calling PartnersApi->confirm_partner_adapter_connection: #{e}"
|
|
81
81
|
end
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
#### Using the
|
|
84
|
+
#### Using the confirm_partner_adapter_connection_with_http_info variant
|
|
85
85
|
|
|
86
86
|
This returns an Array which contains the response data, status code and headers.
|
|
87
87
|
|
|
88
|
-
> <Array(<
|
|
88
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> confirm_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
89
89
|
|
|
90
90
|
```ruby
|
|
91
91
|
begin
|
|
92
92
|
# Confirm a partner's adapter address with the code that was emailed to it
|
|
93
|
-
data, status_code, headers = api_instance.
|
|
93
|
+
data, status_code, headers = api_instance.confirm_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
94
94
|
p status_code # => 2xx
|
|
95
95
|
p headers # => { ... }
|
|
96
|
-
p data # => <
|
|
96
|
+
p data # => <AdapterConnectionResponse>
|
|
97
97
|
rescue ApiSdkRb::ApiError => e
|
|
98
|
-
puts "Error when calling PartnersApi->
|
|
98
|
+
puts "Error when calling PartnersApi->confirm_partner_adapter_connection_with_http_info: #{e}"
|
|
99
99
|
end
|
|
100
100
|
```
|
|
101
101
|
|
|
@@ -110,7 +110,7 @@ end
|
|
|
110
110
|
|
|
111
111
|
### Return type
|
|
112
112
|
|
|
113
|
-
[**
|
|
113
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
114
114
|
|
|
115
115
|
### Authorization
|
|
116
116
|
|
|
@@ -122,9 +122,9 @@ end
|
|
|
122
122
|
- **Accept**: application/json
|
|
123
123
|
|
|
124
124
|
|
|
125
|
-
##
|
|
125
|
+
## create_partner_extra_credits_invoice
|
|
126
126
|
|
|
127
|
-
> <PartnerExtraCreditsInvoiceResponse>
|
|
127
|
+
> <PartnerExtraCreditsInvoiceResponse> create_partner_extra_credits_invoice(partner_id, idempotency_key, request_extra_credits)
|
|
128
128
|
|
|
129
129
|
Buy extra credits for a partner
|
|
130
130
|
|
|
@@ -148,28 +148,28 @@ request_extra_credits = ApiSdkRb::RequestExtraCredits.new({usd: 250}) # RequestE
|
|
|
148
148
|
|
|
149
149
|
begin
|
|
150
150
|
# Buy extra credits for a partner
|
|
151
|
-
result = api_instance.
|
|
151
|
+
result = api_instance.create_partner_extra_credits_invoice(partner_id, idempotency_key, request_extra_credits)
|
|
152
152
|
p result
|
|
153
153
|
rescue ApiSdkRb::ApiError => e
|
|
154
|
-
puts "Error when calling PartnersApi->
|
|
154
|
+
puts "Error when calling PartnersApi->create_partner_extra_credits_invoice: #{e}"
|
|
155
155
|
end
|
|
156
156
|
```
|
|
157
157
|
|
|
158
|
-
#### Using the
|
|
158
|
+
#### Using the create_partner_extra_credits_invoice_with_http_info variant
|
|
159
159
|
|
|
160
160
|
This returns an Array which contains the response data, status code and headers.
|
|
161
161
|
|
|
162
|
-
> <Array(<PartnerExtraCreditsInvoiceResponse>, Integer, Hash)>
|
|
162
|
+
> <Array(<PartnerExtraCreditsInvoiceResponse>, Integer, Hash)> create_partner_extra_credits_invoice_with_http_info(partner_id, idempotency_key, request_extra_credits)
|
|
163
163
|
|
|
164
164
|
```ruby
|
|
165
165
|
begin
|
|
166
166
|
# Buy extra credits for a partner
|
|
167
|
-
data, status_code, headers = api_instance.
|
|
167
|
+
data, status_code, headers = api_instance.create_partner_extra_credits_invoice_with_http_info(partner_id, idempotency_key, request_extra_credits)
|
|
168
168
|
p status_code # => 2xx
|
|
169
169
|
p headers # => { ... }
|
|
170
170
|
p data # => <PartnerExtraCreditsInvoiceResponse>
|
|
171
171
|
rescue ApiSdkRb::ApiError => e
|
|
172
|
-
puts "Error when calling PartnersApi->
|
|
172
|
+
puts "Error when calling PartnersApi->create_partner_extra_credits_invoice_with_http_info: #{e}"
|
|
173
173
|
end
|
|
174
174
|
```
|
|
175
175
|
|
|
@@ -195,9 +195,9 @@ end
|
|
|
195
195
|
- **Accept**: application/json
|
|
196
196
|
|
|
197
197
|
|
|
198
|
-
##
|
|
198
|
+
## get_my_partners
|
|
199
199
|
|
|
200
|
-
> <MyPartnersResponse>
|
|
200
|
+
> <MyPartnersResponse> get_my_partners
|
|
201
201
|
|
|
202
202
|
Find the partner you administer
|
|
203
203
|
|
|
@@ -218,28 +218,28 @@ api_instance = ApiSdkRb::PartnersApi.new
|
|
|
218
218
|
|
|
219
219
|
begin
|
|
220
220
|
# Find the partner you administer
|
|
221
|
-
result = api_instance.
|
|
221
|
+
result = api_instance.get_my_partners
|
|
222
222
|
p result
|
|
223
223
|
rescue ApiSdkRb::ApiError => e
|
|
224
|
-
puts "Error when calling PartnersApi->
|
|
224
|
+
puts "Error when calling PartnersApi->get_my_partners: #{e}"
|
|
225
225
|
end
|
|
226
226
|
```
|
|
227
227
|
|
|
228
|
-
#### Using the
|
|
228
|
+
#### Using the get_my_partners_with_http_info variant
|
|
229
229
|
|
|
230
230
|
This returns an Array which contains the response data, status code and headers.
|
|
231
231
|
|
|
232
|
-
> <Array(<MyPartnersResponse>, Integer, Hash)>
|
|
232
|
+
> <Array(<MyPartnersResponse>, Integer, Hash)> get_my_partners_with_http_info
|
|
233
233
|
|
|
234
234
|
```ruby
|
|
235
235
|
begin
|
|
236
236
|
# Find the partner you administer
|
|
237
|
-
data, status_code, headers = api_instance.
|
|
237
|
+
data, status_code, headers = api_instance.get_my_partners_with_http_info
|
|
238
238
|
p status_code # => 2xx
|
|
239
239
|
p headers # => { ... }
|
|
240
240
|
p data # => <MyPartnersResponse>
|
|
241
241
|
rescue ApiSdkRb::ApiError => e
|
|
242
|
-
puts "Error when calling PartnersApi->
|
|
242
|
+
puts "Error when calling PartnersApi->get_my_partners_with_http_info: #{e}"
|
|
243
243
|
end
|
|
244
244
|
```
|
|
245
245
|
|
|
@@ -261,9 +261,9 @@ This endpoint does not need any parameter.
|
|
|
261
261
|
- **Accept**: application/json
|
|
262
262
|
|
|
263
263
|
|
|
264
|
-
##
|
|
264
|
+
## get_partner_adapter_connections
|
|
265
265
|
|
|
266
|
-
> <
|
|
266
|
+
> <AdapterConnectionListResponse> get_partner_adapter_connections(partner_id)
|
|
267
267
|
|
|
268
268
|
See which adapter keys a partner has connected
|
|
269
269
|
|
|
@@ -285,28 +285,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
285
285
|
|
|
286
286
|
begin
|
|
287
287
|
# See which adapter keys a partner has connected
|
|
288
|
-
result = api_instance.
|
|
288
|
+
result = api_instance.get_partner_adapter_connections(partner_id)
|
|
289
289
|
p result
|
|
290
290
|
rescue ApiSdkRb::ApiError => e
|
|
291
|
-
puts "Error when calling PartnersApi->
|
|
291
|
+
puts "Error when calling PartnersApi->get_partner_adapter_connections: #{e}"
|
|
292
292
|
end
|
|
293
293
|
```
|
|
294
294
|
|
|
295
|
-
#### Using the
|
|
295
|
+
#### Using the get_partner_adapter_connections_with_http_info variant
|
|
296
296
|
|
|
297
297
|
This returns an Array which contains the response data, status code and headers.
|
|
298
298
|
|
|
299
|
-
> <Array(<
|
|
299
|
+
> <Array(<AdapterConnectionListResponse>, Integer, Hash)> get_partner_adapter_connections_with_http_info(partner_id)
|
|
300
300
|
|
|
301
301
|
```ruby
|
|
302
302
|
begin
|
|
303
303
|
# See which adapter keys a partner has connected
|
|
304
|
-
data, status_code, headers = api_instance.
|
|
304
|
+
data, status_code, headers = api_instance.get_partner_adapter_connections_with_http_info(partner_id)
|
|
305
305
|
p status_code # => 2xx
|
|
306
306
|
p headers # => { ... }
|
|
307
|
-
p data # => <
|
|
307
|
+
p data # => <AdapterConnectionListResponse>
|
|
308
308
|
rescue ApiSdkRb::ApiError => e
|
|
309
|
-
puts "Error when calling PartnersApi->
|
|
309
|
+
puts "Error when calling PartnersApi->get_partner_adapter_connections_with_http_info: #{e}"
|
|
310
310
|
end
|
|
311
311
|
```
|
|
312
312
|
|
|
@@ -318,7 +318,7 @@ end
|
|
|
318
318
|
|
|
319
319
|
### Return type
|
|
320
320
|
|
|
321
|
-
[**
|
|
321
|
+
[**AdapterConnectionListResponse**](AdapterConnectionListResponse.md)
|
|
322
322
|
|
|
323
323
|
### Authorization
|
|
324
324
|
|
|
@@ -330,9 +330,9 @@ end
|
|
|
330
330
|
- **Accept**: application/json
|
|
331
331
|
|
|
332
332
|
|
|
333
|
-
##
|
|
333
|
+
## get_partner_analytics_by_managed_user
|
|
334
334
|
|
|
335
|
-
> <PartnerAnalyticsByManagedUserResponse>
|
|
335
|
+
> <PartnerAnalyticsByManagedUserResponse> get_partner_analytics_by_managed_user(partner_id, opts)
|
|
336
336
|
|
|
337
337
|
What each managed user's widgets did
|
|
338
338
|
|
|
@@ -360,28 +360,28 @@ opts = {
|
|
|
360
360
|
|
|
361
361
|
begin
|
|
362
362
|
# What each managed user's widgets did
|
|
363
|
-
result = api_instance.
|
|
363
|
+
result = api_instance.get_partner_analytics_by_managed_user(partner_id, opts)
|
|
364
364
|
p result
|
|
365
365
|
rescue ApiSdkRb::ApiError => e
|
|
366
|
-
puts "Error when calling PartnersApi->
|
|
366
|
+
puts "Error when calling PartnersApi->get_partner_analytics_by_managed_user: #{e}"
|
|
367
367
|
end
|
|
368
368
|
```
|
|
369
369
|
|
|
370
|
-
#### Using the
|
|
370
|
+
#### Using the get_partner_analytics_by_managed_user_with_http_info variant
|
|
371
371
|
|
|
372
372
|
This returns an Array which contains the response data, status code and headers.
|
|
373
373
|
|
|
374
|
-
> <Array(<PartnerAnalyticsByManagedUserResponse>, Integer, Hash)>
|
|
374
|
+
> <Array(<PartnerAnalyticsByManagedUserResponse>, Integer, Hash)> get_partner_analytics_by_managed_user_with_http_info(partner_id, opts)
|
|
375
375
|
|
|
376
376
|
```ruby
|
|
377
377
|
begin
|
|
378
378
|
# What each managed user's widgets did
|
|
379
|
-
data, status_code, headers = api_instance.
|
|
379
|
+
data, status_code, headers = api_instance.get_partner_analytics_by_managed_user_with_http_info(partner_id, opts)
|
|
380
380
|
p status_code # => 2xx
|
|
381
381
|
p headers # => { ... }
|
|
382
382
|
p data # => <PartnerAnalyticsByManagedUserResponse>
|
|
383
383
|
rescue ApiSdkRb::ApiError => e
|
|
384
|
-
puts "Error when calling PartnersApi->
|
|
384
|
+
puts "Error when calling PartnersApi->get_partner_analytics_by_managed_user_with_http_info: #{e}"
|
|
385
385
|
end
|
|
386
386
|
```
|
|
387
387
|
|
|
@@ -409,9 +409,9 @@ end
|
|
|
409
409
|
- **Accept**: application/json
|
|
410
410
|
|
|
411
411
|
|
|
412
|
-
##
|
|
412
|
+
## get_partner_analytics_summary
|
|
413
413
|
|
|
414
|
-
> <PartnerAnalyticsSummaryResponse>
|
|
414
|
+
> <PartnerAnalyticsSummaryResponse> get_partner_analytics_summary(partner_id, opts)
|
|
415
415
|
|
|
416
416
|
What was done with a partner's published widgets
|
|
417
417
|
|
|
@@ -439,28 +439,28 @@ opts = {
|
|
|
439
439
|
|
|
440
440
|
begin
|
|
441
441
|
# What was done with a partner's published widgets
|
|
442
|
-
result = api_instance.
|
|
442
|
+
result = api_instance.get_partner_analytics_summary(partner_id, opts)
|
|
443
443
|
p result
|
|
444
444
|
rescue ApiSdkRb::ApiError => e
|
|
445
|
-
puts "Error when calling PartnersApi->
|
|
445
|
+
puts "Error when calling PartnersApi->get_partner_analytics_summary: #{e}"
|
|
446
446
|
end
|
|
447
447
|
```
|
|
448
448
|
|
|
449
|
-
#### Using the
|
|
449
|
+
#### Using the get_partner_analytics_summary_with_http_info variant
|
|
450
450
|
|
|
451
451
|
This returns an Array which contains the response data, status code and headers.
|
|
452
452
|
|
|
453
|
-
> <Array(<PartnerAnalyticsSummaryResponse>, Integer, Hash)>
|
|
453
|
+
> <Array(<PartnerAnalyticsSummaryResponse>, Integer, Hash)> get_partner_analytics_summary_with_http_info(partner_id, opts)
|
|
454
454
|
|
|
455
455
|
```ruby
|
|
456
456
|
begin
|
|
457
457
|
# What was done with a partner's published widgets
|
|
458
|
-
data, status_code, headers = api_instance.
|
|
458
|
+
data, status_code, headers = api_instance.get_partner_analytics_summary_with_http_info(partner_id, opts)
|
|
459
459
|
p status_code # => 2xx
|
|
460
460
|
p headers # => { ... }
|
|
461
461
|
p data # => <PartnerAnalyticsSummaryResponse>
|
|
462
462
|
rescue ApiSdkRb::ApiError => e
|
|
463
|
-
puts "Error when calling PartnersApi->
|
|
463
|
+
puts "Error when calling PartnersApi->get_partner_analytics_summary_with_http_info: #{e}"
|
|
464
464
|
end
|
|
465
465
|
```
|
|
466
466
|
|
|
@@ -488,9 +488,9 @@ end
|
|
|
488
488
|
- **Accept**: application/json
|
|
489
489
|
|
|
490
490
|
|
|
491
|
-
##
|
|
491
|
+
## get_partner_analytics_timeline
|
|
492
492
|
|
|
493
|
-
> <PartnerAnalyticsTimelineResponse>
|
|
493
|
+
> <PartnerAnalyticsTimelineResponse> get_partner_analytics_timeline(partner_id, opts)
|
|
494
494
|
|
|
495
495
|
What was done with a partner's widgets, day by day
|
|
496
496
|
|
|
@@ -518,28 +518,28 @@ opts = {
|
|
|
518
518
|
|
|
519
519
|
begin
|
|
520
520
|
# What was done with a partner's widgets, day by day
|
|
521
|
-
result = api_instance.
|
|
521
|
+
result = api_instance.get_partner_analytics_timeline(partner_id, opts)
|
|
522
522
|
p result
|
|
523
523
|
rescue ApiSdkRb::ApiError => e
|
|
524
|
-
puts "Error when calling PartnersApi->
|
|
524
|
+
puts "Error when calling PartnersApi->get_partner_analytics_timeline: #{e}"
|
|
525
525
|
end
|
|
526
526
|
```
|
|
527
527
|
|
|
528
|
-
#### Using the
|
|
528
|
+
#### Using the get_partner_analytics_timeline_with_http_info variant
|
|
529
529
|
|
|
530
530
|
This returns an Array which contains the response data, status code and headers.
|
|
531
531
|
|
|
532
|
-
> <Array(<PartnerAnalyticsTimelineResponse>, Integer, Hash)>
|
|
532
|
+
> <Array(<PartnerAnalyticsTimelineResponse>, Integer, Hash)> get_partner_analytics_timeline_with_http_info(partner_id, opts)
|
|
533
533
|
|
|
534
534
|
```ruby
|
|
535
535
|
begin
|
|
536
536
|
# What was done with a partner's widgets, day by day
|
|
537
|
-
data, status_code, headers = api_instance.
|
|
537
|
+
data, status_code, headers = api_instance.get_partner_analytics_timeline_with_http_info(partner_id, opts)
|
|
538
538
|
p status_code # => 2xx
|
|
539
539
|
p headers # => { ... }
|
|
540
540
|
p data # => <PartnerAnalyticsTimelineResponse>
|
|
541
541
|
rescue ApiSdkRb::ApiError => e
|
|
542
|
-
puts "Error when calling PartnersApi->
|
|
542
|
+
puts "Error when calling PartnersApi->get_partner_analytics_timeline_with_http_info: #{e}"
|
|
543
543
|
end
|
|
544
544
|
```
|
|
545
545
|
|
|
@@ -567,9 +567,9 @@ end
|
|
|
567
567
|
- **Accept**: application/json
|
|
568
568
|
|
|
569
569
|
|
|
570
|
-
##
|
|
570
|
+
## get_partner_analytics_top_widgets
|
|
571
571
|
|
|
572
|
-
> <PartnerAnalyticsTopWidgetsResponse>
|
|
572
|
+
> <PartnerAnalyticsTopWidgetsResponse> get_partner_analytics_top_widgets(partner_id, opts)
|
|
573
573
|
|
|
574
574
|
Which widgets were viewed the most
|
|
575
575
|
|
|
@@ -598,28 +598,28 @@ opts = {
|
|
|
598
598
|
|
|
599
599
|
begin
|
|
600
600
|
# Which widgets were viewed the most
|
|
601
|
-
result = api_instance.
|
|
601
|
+
result = api_instance.get_partner_analytics_top_widgets(partner_id, opts)
|
|
602
602
|
p result
|
|
603
603
|
rescue ApiSdkRb::ApiError => e
|
|
604
|
-
puts "Error when calling PartnersApi->
|
|
604
|
+
puts "Error when calling PartnersApi->get_partner_analytics_top_widgets: #{e}"
|
|
605
605
|
end
|
|
606
606
|
```
|
|
607
607
|
|
|
608
|
-
#### Using the
|
|
608
|
+
#### Using the get_partner_analytics_top_widgets_with_http_info variant
|
|
609
609
|
|
|
610
610
|
This returns an Array which contains the response data, status code and headers.
|
|
611
611
|
|
|
612
|
-
> <Array(<PartnerAnalyticsTopWidgetsResponse>, Integer, Hash)>
|
|
612
|
+
> <Array(<PartnerAnalyticsTopWidgetsResponse>, Integer, Hash)> get_partner_analytics_top_widgets_with_http_info(partner_id, opts)
|
|
613
613
|
|
|
614
614
|
```ruby
|
|
615
615
|
begin
|
|
616
616
|
# Which widgets were viewed the most
|
|
617
|
-
data, status_code, headers = api_instance.
|
|
617
|
+
data, status_code, headers = api_instance.get_partner_analytics_top_widgets_with_http_info(partner_id, opts)
|
|
618
618
|
p status_code # => 2xx
|
|
619
619
|
p headers # => { ... }
|
|
620
620
|
p data # => <PartnerAnalyticsTopWidgetsResponse>
|
|
621
621
|
rescue ApiSdkRb::ApiError => e
|
|
622
|
-
puts "Error when calling PartnersApi->
|
|
622
|
+
puts "Error when calling PartnersApi->get_partner_analytics_top_widgets_with_http_info: #{e}"
|
|
623
623
|
end
|
|
624
624
|
```
|
|
625
625
|
|
|
@@ -648,9 +648,9 @@ end
|
|
|
648
648
|
- **Accept**: application/json
|
|
649
649
|
|
|
650
650
|
|
|
651
|
-
##
|
|
651
|
+
## get_partner_billing_overview
|
|
652
652
|
|
|
653
|
-
> <GetPartnerBillingOverview200Response>
|
|
653
|
+
> <GetPartnerBillingOverview200Response> get_partner_billing_overview(partner_id)
|
|
654
654
|
|
|
655
655
|
Get comprehensive partner billing overview
|
|
656
656
|
|
|
@@ -672,28 +672,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Partner ID
|
|
|
672
672
|
|
|
673
673
|
begin
|
|
674
674
|
# Get comprehensive partner billing overview
|
|
675
|
-
result = api_instance.
|
|
675
|
+
result = api_instance.get_partner_billing_overview(partner_id)
|
|
676
676
|
p result
|
|
677
677
|
rescue ApiSdkRb::ApiError => e
|
|
678
|
-
puts "Error when calling PartnersApi->
|
|
678
|
+
puts "Error when calling PartnersApi->get_partner_billing_overview: #{e}"
|
|
679
679
|
end
|
|
680
680
|
```
|
|
681
681
|
|
|
682
|
-
#### Using the
|
|
682
|
+
#### Using the get_partner_billing_overview_with_http_info variant
|
|
683
683
|
|
|
684
684
|
This returns an Array which contains the response data, status code and headers.
|
|
685
685
|
|
|
686
|
-
> <Array(<GetPartnerBillingOverview200Response>, Integer, Hash)>
|
|
686
|
+
> <Array(<GetPartnerBillingOverview200Response>, Integer, Hash)> get_partner_billing_overview_with_http_info(partner_id)
|
|
687
687
|
|
|
688
688
|
```ruby
|
|
689
689
|
begin
|
|
690
690
|
# Get comprehensive partner billing overview
|
|
691
|
-
data, status_code, headers = api_instance.
|
|
691
|
+
data, status_code, headers = api_instance.get_partner_billing_overview_with_http_info(partner_id)
|
|
692
692
|
p status_code # => 2xx
|
|
693
693
|
p headers # => { ... }
|
|
694
694
|
p data # => <GetPartnerBillingOverview200Response>
|
|
695
695
|
rescue ApiSdkRb::ApiError => e
|
|
696
|
-
puts "Error when calling PartnersApi->
|
|
696
|
+
puts "Error when calling PartnersApi->get_partner_billing_overview_with_http_info: #{e}"
|
|
697
697
|
end
|
|
698
698
|
```
|
|
699
699
|
|
|
@@ -717,9 +717,9 @@ end
|
|
|
717
717
|
- **Accept**: application/json
|
|
718
718
|
|
|
719
719
|
|
|
720
|
-
##
|
|
720
|
+
## get_partner_contract
|
|
721
721
|
|
|
722
|
-
> <PartnerContractResponse>
|
|
722
|
+
> <PartnerContractResponse> get_partner_contract(partner_id)
|
|
723
723
|
|
|
724
724
|
Get a partner's contract
|
|
725
725
|
|
|
@@ -741,28 +741,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
741
741
|
|
|
742
742
|
begin
|
|
743
743
|
# Get a partner's contract
|
|
744
|
-
result = api_instance.
|
|
744
|
+
result = api_instance.get_partner_contract(partner_id)
|
|
745
745
|
p result
|
|
746
746
|
rescue ApiSdkRb::ApiError => e
|
|
747
|
-
puts "Error when calling PartnersApi->
|
|
747
|
+
puts "Error when calling PartnersApi->get_partner_contract: #{e}"
|
|
748
748
|
end
|
|
749
749
|
```
|
|
750
750
|
|
|
751
|
-
#### Using the
|
|
751
|
+
#### Using the get_partner_contract_with_http_info variant
|
|
752
752
|
|
|
753
753
|
This returns an Array which contains the response data, status code and headers.
|
|
754
754
|
|
|
755
|
-
> <Array(<PartnerContractResponse>, Integer, Hash)>
|
|
755
|
+
> <Array(<PartnerContractResponse>, Integer, Hash)> get_partner_contract_with_http_info(partner_id)
|
|
756
756
|
|
|
757
757
|
```ruby
|
|
758
758
|
begin
|
|
759
759
|
# Get a partner's contract
|
|
760
|
-
data, status_code, headers = api_instance.
|
|
760
|
+
data, status_code, headers = api_instance.get_partner_contract_with_http_info(partner_id)
|
|
761
761
|
p status_code # => 2xx
|
|
762
762
|
p headers # => { ... }
|
|
763
763
|
p data # => <PartnerContractResponse>
|
|
764
764
|
rescue ApiSdkRb::ApiError => e
|
|
765
|
-
puts "Error when calling PartnersApi->
|
|
765
|
+
puts "Error when calling PartnersApi->get_partner_contract_with_http_info: #{e}"
|
|
766
766
|
end
|
|
767
767
|
```
|
|
768
768
|
|
|
@@ -786,9 +786,9 @@ end
|
|
|
786
786
|
- **Accept**: application/json
|
|
787
787
|
|
|
788
788
|
|
|
789
|
-
##
|
|
789
|
+
## get_partner_credit_balance
|
|
790
790
|
|
|
791
|
-
> <AccountCreditBalanceResponse>
|
|
791
|
+
> <AccountCreditBalanceResponse> get_partner_credit_balance(partner_id)
|
|
792
792
|
|
|
793
793
|
Get partner credit balance
|
|
794
794
|
|
|
@@ -810,28 +810,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Partner ID
|
|
|
810
810
|
|
|
811
811
|
begin
|
|
812
812
|
# Get partner credit balance
|
|
813
|
-
result = api_instance.
|
|
813
|
+
result = api_instance.get_partner_credit_balance(partner_id)
|
|
814
814
|
p result
|
|
815
815
|
rescue ApiSdkRb::ApiError => e
|
|
816
|
-
puts "Error when calling PartnersApi->
|
|
816
|
+
puts "Error when calling PartnersApi->get_partner_credit_balance: #{e}"
|
|
817
817
|
end
|
|
818
818
|
```
|
|
819
819
|
|
|
820
|
-
#### Using the
|
|
820
|
+
#### Using the get_partner_credit_balance_with_http_info variant
|
|
821
821
|
|
|
822
822
|
This returns an Array which contains the response data, status code and headers.
|
|
823
823
|
|
|
824
|
-
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)>
|
|
824
|
+
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)> get_partner_credit_balance_with_http_info(partner_id)
|
|
825
825
|
|
|
826
826
|
```ruby
|
|
827
827
|
begin
|
|
828
828
|
# Get partner credit balance
|
|
829
|
-
data, status_code, headers = api_instance.
|
|
829
|
+
data, status_code, headers = api_instance.get_partner_credit_balance_with_http_info(partner_id)
|
|
830
830
|
p status_code # => 2xx
|
|
831
831
|
p headers # => { ... }
|
|
832
832
|
p data # => <AccountCreditBalanceResponse>
|
|
833
833
|
rescue ApiSdkRb::ApiError => e
|
|
834
|
-
puts "Error when calling PartnersApi->
|
|
834
|
+
puts "Error when calling PartnersApi->get_partner_credit_balance_with_http_info: #{e}"
|
|
835
835
|
end
|
|
836
836
|
```
|
|
837
837
|
|
|
@@ -855,9 +855,9 @@ end
|
|
|
855
855
|
- **Accept**: application/json
|
|
856
856
|
|
|
857
857
|
|
|
858
|
-
##
|
|
858
|
+
## get_partner_credit_transactions
|
|
859
859
|
|
|
860
|
-
> <
|
|
860
|
+
> <AccountCreditTransactionListResponse> get_partner_credit_transactions(partner_id, opts)
|
|
861
861
|
|
|
862
862
|
Get partner credit transaction history
|
|
863
863
|
|
|
@@ -884,28 +884,28 @@ opts = {
|
|
|
884
884
|
|
|
885
885
|
begin
|
|
886
886
|
# Get partner credit transaction history
|
|
887
|
-
result = api_instance.
|
|
887
|
+
result = api_instance.get_partner_credit_transactions(partner_id, opts)
|
|
888
888
|
p result
|
|
889
889
|
rescue ApiSdkRb::ApiError => e
|
|
890
|
-
puts "Error when calling PartnersApi->
|
|
890
|
+
puts "Error when calling PartnersApi->get_partner_credit_transactions: #{e}"
|
|
891
891
|
end
|
|
892
892
|
```
|
|
893
893
|
|
|
894
|
-
#### Using the
|
|
894
|
+
#### Using the get_partner_credit_transactions_with_http_info variant
|
|
895
895
|
|
|
896
896
|
This returns an Array which contains the response data, status code and headers.
|
|
897
897
|
|
|
898
|
-
> <Array(<
|
|
898
|
+
> <Array(<AccountCreditTransactionListResponse>, Integer, Hash)> get_partner_credit_transactions_with_http_info(partner_id, opts)
|
|
899
899
|
|
|
900
900
|
```ruby
|
|
901
901
|
begin
|
|
902
902
|
# Get partner credit transaction history
|
|
903
|
-
data, status_code, headers = api_instance.
|
|
903
|
+
data, status_code, headers = api_instance.get_partner_credit_transactions_with_http_info(partner_id, opts)
|
|
904
904
|
p status_code # => 2xx
|
|
905
905
|
p headers # => { ... }
|
|
906
|
-
p data # => <
|
|
906
|
+
p data # => <AccountCreditTransactionListResponse>
|
|
907
907
|
rescue ApiSdkRb::ApiError => e
|
|
908
|
-
puts "Error when calling PartnersApi->
|
|
908
|
+
puts "Error when calling PartnersApi->get_partner_credit_transactions_with_http_info: #{e}"
|
|
909
909
|
end
|
|
910
910
|
```
|
|
911
911
|
|
|
@@ -920,7 +920,7 @@ end
|
|
|
920
920
|
|
|
921
921
|
### Return type
|
|
922
922
|
|
|
923
|
-
[**
|
|
923
|
+
[**AccountCreditTransactionListResponse**](AccountCreditTransactionListResponse.md)
|
|
924
924
|
|
|
925
925
|
### Authorization
|
|
926
926
|
|
|
@@ -932,9 +932,9 @@ end
|
|
|
932
932
|
- **Accept**: application/json
|
|
933
933
|
|
|
934
934
|
|
|
935
|
-
##
|
|
935
|
+
## get_partner_data_database
|
|
936
936
|
|
|
937
|
-
> <PartnerDataDatabaseResponse>
|
|
937
|
+
> <PartnerDataDatabaseResponse> get_partner_data_database(partner_id)
|
|
938
938
|
|
|
939
939
|
See the Neon database a partner keeps the data of its compositions in
|
|
940
940
|
|
|
@@ -956,28 +956,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
956
956
|
|
|
957
957
|
begin
|
|
958
958
|
# See the Neon database a partner keeps the data of its compositions in
|
|
959
|
-
result = api_instance.
|
|
959
|
+
result = api_instance.get_partner_data_database(partner_id)
|
|
960
960
|
p result
|
|
961
961
|
rescue ApiSdkRb::ApiError => e
|
|
962
|
-
puts "Error when calling PartnersApi->
|
|
962
|
+
puts "Error when calling PartnersApi->get_partner_data_database: #{e}"
|
|
963
963
|
end
|
|
964
964
|
```
|
|
965
965
|
|
|
966
|
-
#### Using the
|
|
966
|
+
#### Using the get_partner_data_database_with_http_info variant
|
|
967
967
|
|
|
968
968
|
This returns an Array which contains the response data, status code and headers.
|
|
969
969
|
|
|
970
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
970
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> get_partner_data_database_with_http_info(partner_id)
|
|
971
971
|
|
|
972
972
|
```ruby
|
|
973
973
|
begin
|
|
974
974
|
# See the Neon database a partner keeps the data of its compositions in
|
|
975
|
-
data, status_code, headers = api_instance.
|
|
975
|
+
data, status_code, headers = api_instance.get_partner_data_database_with_http_info(partner_id)
|
|
976
976
|
p status_code # => 2xx
|
|
977
977
|
p headers # => { ... }
|
|
978
978
|
p data # => <PartnerDataDatabaseResponse>
|
|
979
979
|
rescue ApiSdkRb::ApiError => e
|
|
980
|
-
puts "Error when calling PartnersApi->
|
|
980
|
+
puts "Error when calling PartnersApi->get_partner_data_database_with_http_info: #{e}"
|
|
981
981
|
end
|
|
982
982
|
```
|
|
983
983
|
|
|
@@ -1001,9 +1001,9 @@ end
|
|
|
1001
1001
|
- **Accept**: application/json
|
|
1002
1002
|
|
|
1003
1003
|
|
|
1004
|
-
##
|
|
1004
|
+
## get_partner_design_defaults
|
|
1005
1005
|
|
|
1006
|
-
> <
|
|
1006
|
+
> <DesignDefaultsResponse> get_partner_design_defaults(partner_id)
|
|
1007
1007
|
|
|
1008
1008
|
Read partner-wide design defaults
|
|
1009
1009
|
|
|
@@ -1023,28 +1023,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
1023
1023
|
|
|
1024
1024
|
begin
|
|
1025
1025
|
# Read partner-wide design defaults
|
|
1026
|
-
result = api_instance.
|
|
1026
|
+
result = api_instance.get_partner_design_defaults(partner_id)
|
|
1027
1027
|
p result
|
|
1028
1028
|
rescue ApiSdkRb::ApiError => e
|
|
1029
|
-
puts "Error when calling PartnersApi->
|
|
1029
|
+
puts "Error when calling PartnersApi->get_partner_design_defaults: #{e}"
|
|
1030
1030
|
end
|
|
1031
1031
|
```
|
|
1032
1032
|
|
|
1033
|
-
#### Using the
|
|
1033
|
+
#### Using the get_partner_design_defaults_with_http_info variant
|
|
1034
1034
|
|
|
1035
1035
|
This returns an Array which contains the response data, status code and headers.
|
|
1036
1036
|
|
|
1037
|
-
> <Array(<
|
|
1037
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> get_partner_design_defaults_with_http_info(partner_id)
|
|
1038
1038
|
|
|
1039
1039
|
```ruby
|
|
1040
1040
|
begin
|
|
1041
1041
|
# Read partner-wide design defaults
|
|
1042
|
-
data, status_code, headers = api_instance.
|
|
1042
|
+
data, status_code, headers = api_instance.get_partner_design_defaults_with_http_info(partner_id)
|
|
1043
1043
|
p status_code # => 2xx
|
|
1044
1044
|
p headers # => { ... }
|
|
1045
|
-
p data # => <
|
|
1045
|
+
p data # => <DesignDefaultsResponse>
|
|
1046
1046
|
rescue ApiSdkRb::ApiError => e
|
|
1047
|
-
puts "Error when calling PartnersApi->
|
|
1047
|
+
puts "Error when calling PartnersApi->get_partner_design_defaults_with_http_info: #{e}"
|
|
1048
1048
|
end
|
|
1049
1049
|
```
|
|
1050
1050
|
|
|
@@ -1056,7 +1056,7 @@ end
|
|
|
1056
1056
|
|
|
1057
1057
|
### Return type
|
|
1058
1058
|
|
|
1059
|
-
[**
|
|
1059
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
1060
1060
|
|
|
1061
1061
|
### Authorization
|
|
1062
1062
|
|
|
@@ -1068,9 +1068,9 @@ end
|
|
|
1068
1068
|
- **Accept**: application/json
|
|
1069
1069
|
|
|
1070
1070
|
|
|
1071
|
-
##
|
|
1071
|
+
## get_partner_entry_context_signing
|
|
1072
1072
|
|
|
1073
|
-
> <PartnerEntryContextSigningResponse>
|
|
1073
|
+
> <PartnerEntryContextSigningResponse> get_partner_entry_context_signing(partner_id)
|
|
1074
1074
|
|
|
1075
1075
|
See how the context of your embeds is signed
|
|
1076
1076
|
|
|
@@ -1092,28 +1092,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1092
1092
|
|
|
1093
1093
|
begin
|
|
1094
1094
|
# See how the context of your embeds is signed
|
|
1095
|
-
result = api_instance.
|
|
1095
|
+
result = api_instance.get_partner_entry_context_signing(partner_id)
|
|
1096
1096
|
p result
|
|
1097
1097
|
rescue ApiSdkRb::ApiError => e
|
|
1098
|
-
puts "Error when calling PartnersApi->
|
|
1098
|
+
puts "Error when calling PartnersApi->get_partner_entry_context_signing: #{e}"
|
|
1099
1099
|
end
|
|
1100
1100
|
```
|
|
1101
1101
|
|
|
1102
|
-
#### Using the
|
|
1102
|
+
#### Using the get_partner_entry_context_signing_with_http_info variant
|
|
1103
1103
|
|
|
1104
1104
|
This returns an Array which contains the response data, status code and headers.
|
|
1105
1105
|
|
|
1106
|
-
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)>
|
|
1106
|
+
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)> get_partner_entry_context_signing_with_http_info(partner_id)
|
|
1107
1107
|
|
|
1108
1108
|
```ruby
|
|
1109
1109
|
begin
|
|
1110
1110
|
# See how the context of your embeds is signed
|
|
1111
|
-
data, status_code, headers = api_instance.
|
|
1111
|
+
data, status_code, headers = api_instance.get_partner_entry_context_signing_with_http_info(partner_id)
|
|
1112
1112
|
p status_code # => 2xx
|
|
1113
1113
|
p headers # => { ... }
|
|
1114
1114
|
p data # => <PartnerEntryContextSigningResponse>
|
|
1115
1115
|
rescue ApiSdkRb::ApiError => e
|
|
1116
|
-
puts "Error when calling PartnersApi->
|
|
1116
|
+
puts "Error when calling PartnersApi->get_partner_entry_context_signing_with_http_info: #{e}"
|
|
1117
1117
|
end
|
|
1118
1118
|
```
|
|
1119
1119
|
|
|
@@ -1137,9 +1137,9 @@ end
|
|
|
1137
1137
|
- **Accept**: application/json
|
|
1138
1138
|
|
|
1139
1139
|
|
|
1140
|
-
##
|
|
1140
|
+
## get_partner_notification_settings
|
|
1141
1141
|
|
|
1142
|
-
> <PartnerNotificationSettingsResponse>
|
|
1142
|
+
> <PartnerNotificationSettingsResponse> get_partner_notification_settings(partner_id)
|
|
1143
1143
|
|
|
1144
1144
|
Where your notifications go
|
|
1145
1145
|
|
|
@@ -1161,28 +1161,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1161
1161
|
|
|
1162
1162
|
begin
|
|
1163
1163
|
# Where your notifications go
|
|
1164
|
-
result = api_instance.
|
|
1164
|
+
result = api_instance.get_partner_notification_settings(partner_id)
|
|
1165
1165
|
p result
|
|
1166
1166
|
rescue ApiSdkRb::ApiError => e
|
|
1167
|
-
puts "Error when calling PartnersApi->
|
|
1167
|
+
puts "Error when calling PartnersApi->get_partner_notification_settings: #{e}"
|
|
1168
1168
|
end
|
|
1169
1169
|
```
|
|
1170
1170
|
|
|
1171
|
-
#### Using the
|
|
1171
|
+
#### Using the get_partner_notification_settings_with_http_info variant
|
|
1172
1172
|
|
|
1173
1173
|
This returns an Array which contains the response data, status code and headers.
|
|
1174
1174
|
|
|
1175
|
-
> <Array(<PartnerNotificationSettingsResponse>, Integer, Hash)>
|
|
1175
|
+
> <Array(<PartnerNotificationSettingsResponse>, Integer, Hash)> get_partner_notification_settings_with_http_info(partner_id)
|
|
1176
1176
|
|
|
1177
1177
|
```ruby
|
|
1178
1178
|
begin
|
|
1179
1179
|
# Where your notifications go
|
|
1180
|
-
data, status_code, headers = api_instance.
|
|
1180
|
+
data, status_code, headers = api_instance.get_partner_notification_settings_with_http_info(partner_id)
|
|
1181
1181
|
p status_code # => 2xx
|
|
1182
1182
|
p headers # => { ... }
|
|
1183
1183
|
p data # => <PartnerNotificationSettingsResponse>
|
|
1184
1184
|
rescue ApiSdkRb::ApiError => e
|
|
1185
|
-
puts "Error when calling PartnersApi->
|
|
1185
|
+
puts "Error when calling PartnersApi->get_partner_notification_settings_with_http_info: #{e}"
|
|
1186
1186
|
end
|
|
1187
1187
|
```
|
|
1188
1188
|
|
|
@@ -1206,9 +1206,9 @@ end
|
|
|
1206
1206
|
- **Accept**: application/json
|
|
1207
1207
|
|
|
1208
1208
|
|
|
1209
|
-
##
|
|
1209
|
+
## get_partner_storage_destination
|
|
1210
1210
|
|
|
1211
|
-
> <PartnerStorageDestinationResponse>
|
|
1211
|
+
> <PartnerStorageDestinationResponse> get_partner_storage_destination(partner_id)
|
|
1212
1212
|
|
|
1213
1213
|
Get where a partner's uploaded files are stored
|
|
1214
1214
|
|
|
@@ -1230,28 +1230,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1230
1230
|
|
|
1231
1231
|
begin
|
|
1232
1232
|
# Get where a partner's uploaded files are stored
|
|
1233
|
-
result = api_instance.
|
|
1233
|
+
result = api_instance.get_partner_storage_destination(partner_id)
|
|
1234
1234
|
p result
|
|
1235
1235
|
rescue ApiSdkRb::ApiError => e
|
|
1236
|
-
puts "Error when calling PartnersApi->
|
|
1236
|
+
puts "Error when calling PartnersApi->get_partner_storage_destination: #{e}"
|
|
1237
1237
|
end
|
|
1238
1238
|
```
|
|
1239
1239
|
|
|
1240
|
-
#### Using the
|
|
1240
|
+
#### Using the get_partner_storage_destination_with_http_info variant
|
|
1241
1241
|
|
|
1242
1242
|
This returns an Array which contains the response data, status code and headers.
|
|
1243
1243
|
|
|
1244
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
1244
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> get_partner_storage_destination_with_http_info(partner_id)
|
|
1245
1245
|
|
|
1246
1246
|
```ruby
|
|
1247
1247
|
begin
|
|
1248
1248
|
# Get where a partner's uploaded files are stored
|
|
1249
|
-
data, status_code, headers = api_instance.
|
|
1249
|
+
data, status_code, headers = api_instance.get_partner_storage_destination_with_http_info(partner_id)
|
|
1250
1250
|
p status_code # => 2xx
|
|
1251
1251
|
p headers # => { ... }
|
|
1252
1252
|
p data # => <PartnerStorageDestinationResponse>
|
|
1253
1253
|
rescue ApiSdkRb::ApiError => e
|
|
1254
|
-
puts "Error when calling PartnersApi->
|
|
1254
|
+
puts "Error when calling PartnersApi->get_partner_storage_destination_with_http_info: #{e}"
|
|
1255
1255
|
end
|
|
1256
1256
|
```
|
|
1257
1257
|
|
|
@@ -1275,13 +1275,13 @@ end
|
|
|
1275
1275
|
- **Accept**: application/json
|
|
1276
1276
|
|
|
1277
1277
|
|
|
1278
|
-
##
|
|
1278
|
+
## get_partner_storage_usage
|
|
1279
1279
|
|
|
1280
|
-
> <PartnerStorageUsageResponse>
|
|
1280
|
+
> <PartnerStorageUsageResponse> get_partner_storage_usage(partner_id, opts)
|
|
1281
1281
|
|
|
1282
1282
|
What a partner's customers store
|
|
1283
1283
|
|
|
1284
|
-
Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic's storage and how much in your own storage destination (`setPartnerStorageDestination`). Use it to see which customers store the most, or to charge them for it. A file is counted for a managed user when it was filed under that user: by naming `managed_user_id` or `managed_user_external_id` when you upload it (`
|
|
1284
|
+
Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic's storage and how much in your own storage destination (`setPartnerStorageDestination`). Use it to see which customers store the most, or to charge them for it. A file is counted for a managed user when it was filed under that user: by naming `managed_user_id` or `managed_user_external_id` when you upload it (`uploadFile`, or the metadata of a resumable upload), or because it was uploaded through that user's editor session, which files everything under its user. The files that are not filed under anyone (your own, and the ones uploaded without naming a managed user) are the row whose `managedUserId` is null. Deleted files are not counted. To list the files of one managed user, use the `managed_user_id` filter of `listUploads`. The answer is counted when you ask, so it is always current. The groups are ordered by size, the heaviest first, and `page.hasMore` says whether more follow. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
1285
1285
|
|
|
1286
1286
|
### Examples
|
|
1287
1287
|
|
|
@@ -1303,28 +1303,28 @@ opts = {
|
|
|
1303
1303
|
|
|
1304
1304
|
begin
|
|
1305
1305
|
# What a partner's customers store
|
|
1306
|
-
result = api_instance.
|
|
1306
|
+
result = api_instance.get_partner_storage_usage(partner_id, opts)
|
|
1307
1307
|
p result
|
|
1308
1308
|
rescue ApiSdkRb::ApiError => e
|
|
1309
|
-
puts "Error when calling PartnersApi->
|
|
1309
|
+
puts "Error when calling PartnersApi->get_partner_storage_usage: #{e}"
|
|
1310
1310
|
end
|
|
1311
1311
|
```
|
|
1312
1312
|
|
|
1313
|
-
#### Using the
|
|
1313
|
+
#### Using the get_partner_storage_usage_with_http_info variant
|
|
1314
1314
|
|
|
1315
1315
|
This returns an Array which contains the response data, status code and headers.
|
|
1316
1316
|
|
|
1317
|
-
> <Array(<PartnerStorageUsageResponse>, Integer, Hash)>
|
|
1317
|
+
> <Array(<PartnerStorageUsageResponse>, Integer, Hash)> get_partner_storage_usage_with_http_info(partner_id, opts)
|
|
1318
1318
|
|
|
1319
1319
|
```ruby
|
|
1320
1320
|
begin
|
|
1321
1321
|
# What a partner's customers store
|
|
1322
|
-
data, status_code, headers = api_instance.
|
|
1322
|
+
data, status_code, headers = api_instance.get_partner_storage_usage_with_http_info(partner_id, opts)
|
|
1323
1323
|
p status_code # => 2xx
|
|
1324
1324
|
p headers # => { ... }
|
|
1325
1325
|
p data # => <PartnerStorageUsageResponse>
|
|
1326
1326
|
rescue ApiSdkRb::ApiError => e
|
|
1327
|
-
puts "Error when calling PartnersApi->
|
|
1327
|
+
puts "Error when calling PartnersApi->get_partner_storage_usage_with_http_info: #{e}"
|
|
1328
1328
|
end
|
|
1329
1329
|
```
|
|
1330
1330
|
|
|
@@ -1350,9 +1350,9 @@ end
|
|
|
1350
1350
|
- **Accept**: application/json
|
|
1351
1351
|
|
|
1352
1352
|
|
|
1353
|
-
##
|
|
1353
|
+
## list_partner_notification_deliveries
|
|
1354
1354
|
|
|
1355
|
-
> <PartnerNotificationDeliveryLogResponse>
|
|
1355
|
+
> <PartnerNotificationDeliveryLogResponse> list_partner_notification_deliveries(partner_id, opts)
|
|
1356
1356
|
|
|
1357
1357
|
How your notifications reached you
|
|
1358
1358
|
|
|
@@ -1377,28 +1377,28 @@ opts = {
|
|
|
1377
1377
|
|
|
1378
1378
|
begin
|
|
1379
1379
|
# How your notifications reached you
|
|
1380
|
-
result = api_instance.
|
|
1380
|
+
result = api_instance.list_partner_notification_deliveries(partner_id, opts)
|
|
1381
1381
|
p result
|
|
1382
1382
|
rescue ApiSdkRb::ApiError => e
|
|
1383
|
-
puts "Error when calling PartnersApi->
|
|
1383
|
+
puts "Error when calling PartnersApi->list_partner_notification_deliveries: #{e}"
|
|
1384
1384
|
end
|
|
1385
1385
|
```
|
|
1386
1386
|
|
|
1387
|
-
#### Using the
|
|
1387
|
+
#### Using the list_partner_notification_deliveries_with_http_info variant
|
|
1388
1388
|
|
|
1389
1389
|
This returns an Array which contains the response data, status code and headers.
|
|
1390
1390
|
|
|
1391
|
-
> <Array(<PartnerNotificationDeliveryLogResponse>, Integer, Hash)>
|
|
1391
|
+
> <Array(<PartnerNotificationDeliveryLogResponse>, Integer, Hash)> list_partner_notification_deliveries_with_http_info(partner_id, opts)
|
|
1392
1392
|
|
|
1393
1393
|
```ruby
|
|
1394
1394
|
begin
|
|
1395
1395
|
# How your notifications reached you
|
|
1396
|
-
data, status_code, headers = api_instance.
|
|
1396
|
+
data, status_code, headers = api_instance.list_partner_notification_deliveries_with_http_info(partner_id, opts)
|
|
1397
1397
|
p status_code # => 2xx
|
|
1398
1398
|
p headers # => { ... }
|
|
1399
1399
|
p data # => <PartnerNotificationDeliveryLogResponse>
|
|
1400
1400
|
rescue ApiSdkRb::ApiError => e
|
|
1401
|
-
puts "Error when calling PartnersApi->
|
|
1401
|
+
puts "Error when calling PartnersApi->list_partner_notification_deliveries_with_http_info: #{e}"
|
|
1402
1402
|
end
|
|
1403
1403
|
```
|
|
1404
1404
|
|
|
@@ -1423,9 +1423,9 @@ end
|
|
|
1423
1423
|
- **Accept**: application/json
|
|
1424
1424
|
|
|
1425
1425
|
|
|
1426
|
-
##
|
|
1426
|
+
## list_partner_notifications
|
|
1427
1427
|
|
|
1428
|
-
> <PartnerNotificationPageResponse>
|
|
1428
|
+
> <PartnerNotificationPageResponse> list_partner_notifications(partner_id, opts)
|
|
1429
1429
|
|
|
1430
1430
|
What your partner account was told
|
|
1431
1431
|
|
|
@@ -1451,28 +1451,28 @@ opts = {
|
|
|
1451
1451
|
|
|
1452
1452
|
begin
|
|
1453
1453
|
# What your partner account was told
|
|
1454
|
-
result = api_instance.
|
|
1454
|
+
result = api_instance.list_partner_notifications(partner_id, opts)
|
|
1455
1455
|
p result
|
|
1456
1456
|
rescue ApiSdkRb::ApiError => e
|
|
1457
|
-
puts "Error when calling PartnersApi->
|
|
1457
|
+
puts "Error when calling PartnersApi->list_partner_notifications: #{e}"
|
|
1458
1458
|
end
|
|
1459
1459
|
```
|
|
1460
1460
|
|
|
1461
|
-
#### Using the
|
|
1461
|
+
#### Using the list_partner_notifications_with_http_info variant
|
|
1462
1462
|
|
|
1463
1463
|
This returns an Array which contains the response data, status code and headers.
|
|
1464
1464
|
|
|
1465
|
-
> <Array(<PartnerNotificationPageResponse>, Integer, Hash)>
|
|
1465
|
+
> <Array(<PartnerNotificationPageResponse>, Integer, Hash)> list_partner_notifications_with_http_info(partner_id, opts)
|
|
1466
1466
|
|
|
1467
1467
|
```ruby
|
|
1468
1468
|
begin
|
|
1469
1469
|
# What your partner account was told
|
|
1470
|
-
data, status_code, headers = api_instance.
|
|
1470
|
+
data, status_code, headers = api_instance.list_partner_notifications_with_http_info(partner_id, opts)
|
|
1471
1471
|
p status_code # => 2xx
|
|
1472
1472
|
p headers # => { ... }
|
|
1473
1473
|
p data # => <PartnerNotificationPageResponse>
|
|
1474
1474
|
rescue ApiSdkRb::ApiError => e
|
|
1475
|
-
puts "Error when calling PartnersApi->
|
|
1475
|
+
puts "Error when calling PartnersApi->list_partner_notifications_with_http_info: #{e}"
|
|
1476
1476
|
end
|
|
1477
1477
|
```
|
|
1478
1478
|
|
|
@@ -1498,9 +1498,9 @@ end
|
|
|
1498
1498
|
- **Accept**: application/json
|
|
1499
1499
|
|
|
1500
1500
|
|
|
1501
|
-
##
|
|
1501
|
+
## list_partner_presets
|
|
1502
1502
|
|
|
1503
|
-
> <ListPartnerPresets200Response>
|
|
1503
|
+
> <ListPartnerPresets200Response> list_partner_presets(partner_id)
|
|
1504
1504
|
|
|
1505
1505
|
List the widgets a partner offers as presets
|
|
1506
1506
|
|
|
@@ -1522,28 +1522,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1522
1522
|
|
|
1523
1523
|
begin
|
|
1524
1524
|
# List the widgets a partner offers as presets
|
|
1525
|
-
result = api_instance.
|
|
1525
|
+
result = api_instance.list_partner_presets(partner_id)
|
|
1526
1526
|
p result
|
|
1527
1527
|
rescue ApiSdkRb::ApiError => e
|
|
1528
|
-
puts "Error when calling PartnersApi->
|
|
1528
|
+
puts "Error when calling PartnersApi->list_partner_presets: #{e}"
|
|
1529
1529
|
end
|
|
1530
1530
|
```
|
|
1531
1531
|
|
|
1532
|
-
#### Using the
|
|
1532
|
+
#### Using the list_partner_presets_with_http_info variant
|
|
1533
1533
|
|
|
1534
1534
|
This returns an Array which contains the response data, status code and headers.
|
|
1535
1535
|
|
|
1536
|
-
> <Array(<ListPartnerPresets200Response>, Integer, Hash)>
|
|
1536
|
+
> <Array(<ListPartnerPresets200Response>, Integer, Hash)> list_partner_presets_with_http_info(partner_id)
|
|
1537
1537
|
|
|
1538
1538
|
```ruby
|
|
1539
1539
|
begin
|
|
1540
1540
|
# List the widgets a partner offers as presets
|
|
1541
|
-
data, status_code, headers = api_instance.
|
|
1541
|
+
data, status_code, headers = api_instance.list_partner_presets_with_http_info(partner_id)
|
|
1542
1542
|
p status_code # => 2xx
|
|
1543
1543
|
p headers # => { ... }
|
|
1544
1544
|
p data # => <ListPartnerPresets200Response>
|
|
1545
1545
|
rescue ApiSdkRb::ApiError => e
|
|
1546
|
-
puts "Error when calling PartnersApi->
|
|
1546
|
+
puts "Error when calling PartnersApi->list_partner_presets_with_http_info: #{e}"
|
|
1547
1547
|
end
|
|
1548
1548
|
```
|
|
1549
1549
|
|
|
@@ -1567,9 +1567,9 @@ end
|
|
|
1567
1567
|
- **Accept**: application/json
|
|
1568
1568
|
|
|
1569
1569
|
|
|
1570
|
-
##
|
|
1570
|
+
## list_partner_workflow_presets
|
|
1571
1571
|
|
|
1572
|
-
> <ListPartnerWorkflowPresets200Response>
|
|
1572
|
+
> <ListPartnerWorkflowPresets200Response> list_partner_workflow_presets(partner_id)
|
|
1573
1573
|
|
|
1574
1574
|
List the workflows a partner offers as places to start
|
|
1575
1575
|
|
|
@@ -1591,28 +1591,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1591
1591
|
|
|
1592
1592
|
begin
|
|
1593
1593
|
# List the workflows a partner offers as places to start
|
|
1594
|
-
result = api_instance.
|
|
1594
|
+
result = api_instance.list_partner_workflow_presets(partner_id)
|
|
1595
1595
|
p result
|
|
1596
1596
|
rescue ApiSdkRb::ApiError => e
|
|
1597
|
-
puts "Error when calling PartnersApi->
|
|
1597
|
+
puts "Error when calling PartnersApi->list_partner_workflow_presets: #{e}"
|
|
1598
1598
|
end
|
|
1599
1599
|
```
|
|
1600
1600
|
|
|
1601
|
-
#### Using the
|
|
1601
|
+
#### Using the list_partner_workflow_presets_with_http_info variant
|
|
1602
1602
|
|
|
1603
1603
|
This returns an Array which contains the response data, status code and headers.
|
|
1604
1604
|
|
|
1605
|
-
> <Array(<ListPartnerWorkflowPresets200Response>, Integer, Hash)>
|
|
1605
|
+
> <Array(<ListPartnerWorkflowPresets200Response>, Integer, Hash)> list_partner_workflow_presets_with_http_info(partner_id)
|
|
1606
1606
|
|
|
1607
1607
|
```ruby
|
|
1608
1608
|
begin
|
|
1609
1609
|
# List the workflows a partner offers as places to start
|
|
1610
|
-
data, status_code, headers = api_instance.
|
|
1610
|
+
data, status_code, headers = api_instance.list_partner_workflow_presets_with_http_info(partner_id)
|
|
1611
1611
|
p status_code # => 2xx
|
|
1612
1612
|
p headers # => { ... }
|
|
1613
1613
|
p data # => <ListPartnerWorkflowPresets200Response>
|
|
1614
1614
|
rescue ApiSdkRb::ApiError => e
|
|
1615
|
-
puts "Error when calling PartnersApi->
|
|
1615
|
+
puts "Error when calling PartnersApi->list_partner_workflow_presets_with_http_info: #{e}"
|
|
1616
1616
|
end
|
|
1617
1617
|
```
|
|
1618
1618
|
|
|
@@ -1636,9 +1636,9 @@ end
|
|
|
1636
1636
|
- **Accept**: application/json
|
|
1637
1637
|
|
|
1638
1638
|
|
|
1639
|
-
##
|
|
1639
|
+
## remove_partner_adapter_connection
|
|
1640
1640
|
|
|
1641
|
-
> <
|
|
1641
|
+
> <AdapterConnectionRemovalResponse> remove_partner_adapter_connection(partner_id, adapter_id, credential_key)
|
|
1642
1642
|
|
|
1643
1643
|
Remove an adapter key from a partner
|
|
1644
1644
|
|
|
@@ -1662,28 +1662,28 @@ credential_key = 'credential_key_example' # String | The key's name within the a
|
|
|
1662
1662
|
|
|
1663
1663
|
begin
|
|
1664
1664
|
# Remove an adapter key from a partner
|
|
1665
|
-
result = api_instance.
|
|
1665
|
+
result = api_instance.remove_partner_adapter_connection(partner_id, adapter_id, credential_key)
|
|
1666
1666
|
p result
|
|
1667
1667
|
rescue ApiSdkRb::ApiError => e
|
|
1668
|
-
puts "Error when calling PartnersApi->
|
|
1668
|
+
puts "Error when calling PartnersApi->remove_partner_adapter_connection: #{e}"
|
|
1669
1669
|
end
|
|
1670
1670
|
```
|
|
1671
1671
|
|
|
1672
|
-
#### Using the
|
|
1672
|
+
#### Using the remove_partner_adapter_connection_with_http_info variant
|
|
1673
1673
|
|
|
1674
1674
|
This returns an Array which contains the response data, status code and headers.
|
|
1675
1675
|
|
|
1676
|
-
> <Array(<
|
|
1676
|
+
> <Array(<AdapterConnectionRemovalResponse>, Integer, Hash)> remove_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key)
|
|
1677
1677
|
|
|
1678
1678
|
```ruby
|
|
1679
1679
|
begin
|
|
1680
1680
|
# Remove an adapter key from a partner
|
|
1681
|
-
data, status_code, headers = api_instance.
|
|
1681
|
+
data, status_code, headers = api_instance.remove_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key)
|
|
1682
1682
|
p status_code # => 2xx
|
|
1683
1683
|
p headers # => { ... }
|
|
1684
|
-
p data # => <
|
|
1684
|
+
p data # => <AdapterConnectionRemovalResponse>
|
|
1685
1685
|
rescue ApiSdkRb::ApiError => e
|
|
1686
|
-
puts "Error when calling PartnersApi->
|
|
1686
|
+
puts "Error when calling PartnersApi->remove_partner_adapter_connection_with_http_info: #{e}"
|
|
1687
1687
|
end
|
|
1688
1688
|
```
|
|
1689
1689
|
|
|
@@ -1697,7 +1697,7 @@ end
|
|
|
1697
1697
|
|
|
1698
1698
|
### Return type
|
|
1699
1699
|
|
|
1700
|
-
[**
|
|
1700
|
+
[**AdapterConnectionRemovalResponse**](AdapterConnectionRemovalResponse.md)
|
|
1701
1701
|
|
|
1702
1702
|
### Authorization
|
|
1703
1703
|
|
|
@@ -1709,9 +1709,9 @@ end
|
|
|
1709
1709
|
- **Accept**: application/json
|
|
1710
1710
|
|
|
1711
1711
|
|
|
1712
|
-
##
|
|
1712
|
+
## remove_partner_data_database
|
|
1713
1713
|
|
|
1714
|
-
> <PartnerDataDatabaseRemovalResponse>
|
|
1714
|
+
> <PartnerDataDatabaseRemovalResponse> remove_partner_data_database(partner_id)
|
|
1715
1715
|
|
|
1716
1716
|
Stop keeping the data of a partner's compositions in its own database
|
|
1717
1717
|
|
|
@@ -1733,28 +1733,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1733
1733
|
|
|
1734
1734
|
begin
|
|
1735
1735
|
# Stop keeping the data of a partner's compositions in its own database
|
|
1736
|
-
result = api_instance.
|
|
1736
|
+
result = api_instance.remove_partner_data_database(partner_id)
|
|
1737
1737
|
p result
|
|
1738
1738
|
rescue ApiSdkRb::ApiError => e
|
|
1739
|
-
puts "Error when calling PartnersApi->
|
|
1739
|
+
puts "Error when calling PartnersApi->remove_partner_data_database: #{e}"
|
|
1740
1740
|
end
|
|
1741
1741
|
```
|
|
1742
1742
|
|
|
1743
|
-
#### Using the
|
|
1743
|
+
#### Using the remove_partner_data_database_with_http_info variant
|
|
1744
1744
|
|
|
1745
1745
|
This returns an Array which contains the response data, status code and headers.
|
|
1746
1746
|
|
|
1747
|
-
> <Array(<PartnerDataDatabaseRemovalResponse>, Integer, Hash)>
|
|
1747
|
+
> <Array(<PartnerDataDatabaseRemovalResponse>, Integer, Hash)> remove_partner_data_database_with_http_info(partner_id)
|
|
1748
1748
|
|
|
1749
1749
|
```ruby
|
|
1750
1750
|
begin
|
|
1751
1751
|
# Stop keeping the data of a partner's compositions in its own database
|
|
1752
|
-
data, status_code, headers = api_instance.
|
|
1752
|
+
data, status_code, headers = api_instance.remove_partner_data_database_with_http_info(partner_id)
|
|
1753
1753
|
p status_code # => 2xx
|
|
1754
1754
|
p headers # => { ... }
|
|
1755
1755
|
p data # => <PartnerDataDatabaseRemovalResponse>
|
|
1756
1756
|
rescue ApiSdkRb::ApiError => e
|
|
1757
|
-
puts "Error when calling PartnersApi->
|
|
1757
|
+
puts "Error when calling PartnersApi->remove_partner_data_database_with_http_info: #{e}"
|
|
1758
1758
|
end
|
|
1759
1759
|
```
|
|
1760
1760
|
|
|
@@ -1778,9 +1778,9 @@ end
|
|
|
1778
1778
|
- **Accept**: application/json
|
|
1779
1779
|
|
|
1780
1780
|
|
|
1781
|
-
##
|
|
1781
|
+
## remove_partner_preset
|
|
1782
1782
|
|
|
1783
|
-
> <PartnerPresetRemovalResponse>
|
|
1783
|
+
> <PartnerPresetRemovalResponse> remove_partner_preset(partner_id, key)
|
|
1784
1784
|
|
|
1785
1785
|
Take a widget off the partner's presets
|
|
1786
1786
|
|
|
@@ -1803,28 +1803,28 @@ key = 'key_example' # String | The key of the preset to remove
|
|
|
1803
1803
|
|
|
1804
1804
|
begin
|
|
1805
1805
|
# Take a widget off the partner's presets
|
|
1806
|
-
result = api_instance.
|
|
1806
|
+
result = api_instance.remove_partner_preset(partner_id, key)
|
|
1807
1807
|
p result
|
|
1808
1808
|
rescue ApiSdkRb::ApiError => e
|
|
1809
|
-
puts "Error when calling PartnersApi->
|
|
1809
|
+
puts "Error when calling PartnersApi->remove_partner_preset: #{e}"
|
|
1810
1810
|
end
|
|
1811
1811
|
```
|
|
1812
1812
|
|
|
1813
|
-
#### Using the
|
|
1813
|
+
#### Using the remove_partner_preset_with_http_info variant
|
|
1814
1814
|
|
|
1815
1815
|
This returns an Array which contains the response data, status code and headers.
|
|
1816
1816
|
|
|
1817
|
-
> <Array(<PartnerPresetRemovalResponse>, Integer, Hash)>
|
|
1817
|
+
> <Array(<PartnerPresetRemovalResponse>, Integer, Hash)> remove_partner_preset_with_http_info(partner_id, key)
|
|
1818
1818
|
|
|
1819
1819
|
```ruby
|
|
1820
1820
|
begin
|
|
1821
1821
|
# Take a widget off the partner's presets
|
|
1822
|
-
data, status_code, headers = api_instance.
|
|
1822
|
+
data, status_code, headers = api_instance.remove_partner_preset_with_http_info(partner_id, key)
|
|
1823
1823
|
p status_code # => 2xx
|
|
1824
1824
|
p headers # => { ... }
|
|
1825
1825
|
p data # => <PartnerPresetRemovalResponse>
|
|
1826
1826
|
rescue ApiSdkRb::ApiError => e
|
|
1827
|
-
puts "Error when calling PartnersApi->
|
|
1827
|
+
puts "Error when calling PartnersApi->remove_partner_preset_with_http_info: #{e}"
|
|
1828
1828
|
end
|
|
1829
1829
|
```
|
|
1830
1830
|
|
|
@@ -1849,9 +1849,9 @@ end
|
|
|
1849
1849
|
- **Accept**: application/json
|
|
1850
1850
|
|
|
1851
1851
|
|
|
1852
|
-
##
|
|
1852
|
+
## remove_partner_storage_destination
|
|
1853
1853
|
|
|
1854
|
-
> <PartnerStorageRemovalResponse>
|
|
1854
|
+
> <PartnerStorageRemovalResponse> remove_partner_storage_destination(partner_id)
|
|
1855
1855
|
|
|
1856
1856
|
Stop storing a partner's uploaded files in its own bucket
|
|
1857
1857
|
|
|
@@ -1873,28 +1873,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
1873
1873
|
|
|
1874
1874
|
begin
|
|
1875
1875
|
# Stop storing a partner's uploaded files in its own bucket
|
|
1876
|
-
result = api_instance.
|
|
1876
|
+
result = api_instance.remove_partner_storage_destination(partner_id)
|
|
1877
1877
|
p result
|
|
1878
1878
|
rescue ApiSdkRb::ApiError => e
|
|
1879
|
-
puts "Error when calling PartnersApi->
|
|
1879
|
+
puts "Error when calling PartnersApi->remove_partner_storage_destination: #{e}"
|
|
1880
1880
|
end
|
|
1881
1881
|
```
|
|
1882
1882
|
|
|
1883
|
-
#### Using the
|
|
1883
|
+
#### Using the remove_partner_storage_destination_with_http_info variant
|
|
1884
1884
|
|
|
1885
1885
|
This returns an Array which contains the response data, status code and headers.
|
|
1886
1886
|
|
|
1887
|
-
> <Array(<PartnerStorageRemovalResponse>, Integer, Hash)>
|
|
1887
|
+
> <Array(<PartnerStorageRemovalResponse>, Integer, Hash)> remove_partner_storage_destination_with_http_info(partner_id)
|
|
1888
1888
|
|
|
1889
1889
|
```ruby
|
|
1890
1890
|
begin
|
|
1891
1891
|
# Stop storing a partner's uploaded files in its own bucket
|
|
1892
|
-
data, status_code, headers = api_instance.
|
|
1892
|
+
data, status_code, headers = api_instance.remove_partner_storage_destination_with_http_info(partner_id)
|
|
1893
1893
|
p status_code # => 2xx
|
|
1894
1894
|
p headers # => { ... }
|
|
1895
1895
|
p data # => <PartnerStorageRemovalResponse>
|
|
1896
1896
|
rescue ApiSdkRb::ApiError => e
|
|
1897
|
-
puts "Error when calling PartnersApi->
|
|
1897
|
+
puts "Error when calling PartnersApi->remove_partner_storage_destination_with_http_info: #{e}"
|
|
1898
1898
|
end
|
|
1899
1899
|
```
|
|
1900
1900
|
|
|
@@ -1918,9 +1918,9 @@ end
|
|
|
1918
1918
|
- **Accept**: application/json
|
|
1919
1919
|
|
|
1920
1920
|
|
|
1921
|
-
##
|
|
1921
|
+
## remove_partner_workflow_preset
|
|
1922
1922
|
|
|
1923
|
-
> <RemovePartnerWorkflowPreset200Response>
|
|
1923
|
+
> <RemovePartnerWorkflowPreset200Response> remove_partner_workflow_preset(partner_id, key)
|
|
1924
1924
|
|
|
1925
1925
|
Stop offering a workflow as a place to start
|
|
1926
1926
|
|
|
@@ -1943,28 +1943,28 @@ key = 'key_example' # String | The key of the starting point to remove
|
|
|
1943
1943
|
|
|
1944
1944
|
begin
|
|
1945
1945
|
# Stop offering a workflow as a place to start
|
|
1946
|
-
result = api_instance.
|
|
1946
|
+
result = api_instance.remove_partner_workflow_preset(partner_id, key)
|
|
1947
1947
|
p result
|
|
1948
1948
|
rescue ApiSdkRb::ApiError => e
|
|
1949
|
-
puts "Error when calling PartnersApi->
|
|
1949
|
+
puts "Error when calling PartnersApi->remove_partner_workflow_preset: #{e}"
|
|
1950
1950
|
end
|
|
1951
1951
|
```
|
|
1952
1952
|
|
|
1953
|
-
#### Using the
|
|
1953
|
+
#### Using the remove_partner_workflow_preset_with_http_info variant
|
|
1954
1954
|
|
|
1955
1955
|
This returns an Array which contains the response data, status code and headers.
|
|
1956
1956
|
|
|
1957
|
-
> <Array(<RemovePartnerWorkflowPreset200Response>, Integer, Hash)>
|
|
1957
|
+
> <Array(<RemovePartnerWorkflowPreset200Response>, Integer, Hash)> remove_partner_workflow_preset_with_http_info(partner_id, key)
|
|
1958
1958
|
|
|
1959
1959
|
```ruby
|
|
1960
1960
|
begin
|
|
1961
1961
|
# Stop offering a workflow as a place to start
|
|
1962
|
-
data, status_code, headers = api_instance.
|
|
1962
|
+
data, status_code, headers = api_instance.remove_partner_workflow_preset_with_http_info(partner_id, key)
|
|
1963
1963
|
p status_code # => 2xx
|
|
1964
1964
|
p headers # => { ... }
|
|
1965
1965
|
p data # => <RemovePartnerWorkflowPreset200Response>
|
|
1966
1966
|
rescue ApiSdkRb::ApiError => e
|
|
1967
|
-
puts "Error when calling PartnersApi->
|
|
1967
|
+
puts "Error when calling PartnersApi->remove_partner_workflow_preset_with_http_info: #{e}"
|
|
1968
1968
|
end
|
|
1969
1969
|
```
|
|
1970
1970
|
|
|
@@ -1989,9 +1989,9 @@ end
|
|
|
1989
1989
|
- **Accept**: application/json
|
|
1990
1990
|
|
|
1991
1991
|
|
|
1992
|
-
##
|
|
1992
|
+
## replay_partner_notification_delivery
|
|
1993
1993
|
|
|
1994
|
-
> <PartnerNotificationDeliveryResponse>
|
|
1994
|
+
> <PartnerNotificationDeliveryResponse> replay_partner_notification_delivery(partner_id, delivery_id, idempotency_key)
|
|
1995
1995
|
|
|
1996
1996
|
Send a webhook delivery again
|
|
1997
1997
|
|
|
@@ -2015,28 +2015,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
2015
2015
|
|
|
2016
2016
|
begin
|
|
2017
2017
|
# Send a webhook delivery again
|
|
2018
|
-
result = api_instance.
|
|
2018
|
+
result = api_instance.replay_partner_notification_delivery(partner_id, delivery_id, idempotency_key)
|
|
2019
2019
|
p result
|
|
2020
2020
|
rescue ApiSdkRb::ApiError => e
|
|
2021
|
-
puts "Error when calling PartnersApi->
|
|
2021
|
+
puts "Error when calling PartnersApi->replay_partner_notification_delivery: #{e}"
|
|
2022
2022
|
end
|
|
2023
2023
|
```
|
|
2024
2024
|
|
|
2025
|
-
#### Using the
|
|
2025
|
+
#### Using the replay_partner_notification_delivery_with_http_info variant
|
|
2026
2026
|
|
|
2027
2027
|
This returns an Array which contains the response data, status code and headers.
|
|
2028
2028
|
|
|
2029
|
-
> <Array(<PartnerNotificationDeliveryResponse>, Integer, Hash)>
|
|
2029
|
+
> <Array(<PartnerNotificationDeliveryResponse>, Integer, Hash)> replay_partner_notification_delivery_with_http_info(partner_id, delivery_id, idempotency_key)
|
|
2030
2030
|
|
|
2031
2031
|
```ruby
|
|
2032
2032
|
begin
|
|
2033
2033
|
# Send a webhook delivery again
|
|
2034
|
-
data, status_code, headers = api_instance.
|
|
2034
|
+
data, status_code, headers = api_instance.replay_partner_notification_delivery_with_http_info(partner_id, delivery_id, idempotency_key)
|
|
2035
2035
|
p status_code # => 2xx
|
|
2036
2036
|
p headers # => { ... }
|
|
2037
2037
|
p data # => <PartnerNotificationDeliveryResponse>
|
|
2038
2038
|
rescue ApiSdkRb::ApiError => e
|
|
2039
|
-
puts "Error when calling PartnersApi->
|
|
2039
|
+
puts "Error when calling PartnersApi->replay_partner_notification_delivery_with_http_info: #{e}"
|
|
2040
2040
|
end
|
|
2041
2041
|
```
|
|
2042
2042
|
|
|
@@ -2062,9 +2062,9 @@ end
|
|
|
2062
2062
|
- **Accept**: application/json
|
|
2063
2063
|
|
|
2064
2064
|
|
|
2065
|
-
##
|
|
2065
|
+
## rotate_partner_entry_context_secret
|
|
2066
2066
|
|
|
2067
|
-
> <PartnerEntryContextSecretResponse>
|
|
2067
|
+
> <PartnerEntryContextSecretResponse> rotate_partner_entry_context_secret(partner_id, idempotency_key)
|
|
2068
2068
|
|
|
2069
2069
|
Make a secret to sign the context of your embeds
|
|
2070
2070
|
|
|
@@ -2087,28 +2087,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
2087
2087
|
|
|
2088
2088
|
begin
|
|
2089
2089
|
# Make a secret to sign the context of your embeds
|
|
2090
|
-
result = api_instance.
|
|
2090
|
+
result = api_instance.rotate_partner_entry_context_secret(partner_id, idempotency_key)
|
|
2091
2091
|
p result
|
|
2092
2092
|
rescue ApiSdkRb::ApiError => e
|
|
2093
|
-
puts "Error when calling PartnersApi->
|
|
2093
|
+
puts "Error when calling PartnersApi->rotate_partner_entry_context_secret: #{e}"
|
|
2094
2094
|
end
|
|
2095
2095
|
```
|
|
2096
2096
|
|
|
2097
|
-
#### Using the
|
|
2097
|
+
#### Using the rotate_partner_entry_context_secret_with_http_info variant
|
|
2098
2098
|
|
|
2099
2099
|
This returns an Array which contains the response data, status code and headers.
|
|
2100
2100
|
|
|
2101
|
-
> <Array(<PartnerEntryContextSecretResponse>, Integer, Hash)>
|
|
2101
|
+
> <Array(<PartnerEntryContextSecretResponse>, Integer, Hash)> rotate_partner_entry_context_secret_with_http_info(partner_id, idempotency_key)
|
|
2102
2102
|
|
|
2103
2103
|
```ruby
|
|
2104
2104
|
begin
|
|
2105
2105
|
# Make a secret to sign the context of your embeds
|
|
2106
|
-
data, status_code, headers = api_instance.
|
|
2106
|
+
data, status_code, headers = api_instance.rotate_partner_entry_context_secret_with_http_info(partner_id, idempotency_key)
|
|
2107
2107
|
p status_code # => 2xx
|
|
2108
2108
|
p headers # => { ... }
|
|
2109
2109
|
p data # => <PartnerEntryContextSecretResponse>
|
|
2110
2110
|
rescue ApiSdkRb::ApiError => e
|
|
2111
|
-
puts "Error when calling PartnersApi->
|
|
2111
|
+
puts "Error when calling PartnersApi->rotate_partner_entry_context_secret_with_http_info: #{e}"
|
|
2112
2112
|
end
|
|
2113
2113
|
```
|
|
2114
2114
|
|
|
@@ -2133,9 +2133,9 @@ end
|
|
|
2133
2133
|
- **Accept**: application/json
|
|
2134
2134
|
|
|
2135
2135
|
|
|
2136
|
-
##
|
|
2136
|
+
## rotate_partner_webhook_secret
|
|
2137
2137
|
|
|
2138
|
-
> <PartnerNotificationSettingsChangeResponse>
|
|
2138
|
+
> <PartnerNotificationSettingsChangeResponse> rotate_partner_webhook_secret(partner_id, idempotency_key)
|
|
2139
2139
|
|
|
2140
2140
|
Make a new secret for your webhook
|
|
2141
2141
|
|
|
@@ -2158,28 +2158,28 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
2158
2158
|
|
|
2159
2159
|
begin
|
|
2160
2160
|
# Make a new secret for your webhook
|
|
2161
|
-
result = api_instance.
|
|
2161
|
+
result = api_instance.rotate_partner_webhook_secret(partner_id, idempotency_key)
|
|
2162
2162
|
p result
|
|
2163
2163
|
rescue ApiSdkRb::ApiError => e
|
|
2164
|
-
puts "Error when calling PartnersApi->
|
|
2164
|
+
puts "Error when calling PartnersApi->rotate_partner_webhook_secret: #{e}"
|
|
2165
2165
|
end
|
|
2166
2166
|
```
|
|
2167
2167
|
|
|
2168
|
-
#### Using the
|
|
2168
|
+
#### Using the rotate_partner_webhook_secret_with_http_info variant
|
|
2169
2169
|
|
|
2170
2170
|
This returns an Array which contains the response data, status code and headers.
|
|
2171
2171
|
|
|
2172
|
-
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)>
|
|
2172
|
+
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)> rotate_partner_webhook_secret_with_http_info(partner_id, idempotency_key)
|
|
2173
2173
|
|
|
2174
2174
|
```ruby
|
|
2175
2175
|
begin
|
|
2176
2176
|
# Make a new secret for your webhook
|
|
2177
|
-
data, status_code, headers = api_instance.
|
|
2177
|
+
data, status_code, headers = api_instance.rotate_partner_webhook_secret_with_http_info(partner_id, idempotency_key)
|
|
2178
2178
|
p status_code # => 2xx
|
|
2179
2179
|
p headers # => { ... }
|
|
2180
2180
|
p data # => <PartnerNotificationSettingsChangeResponse>
|
|
2181
2181
|
rescue ApiSdkRb::ApiError => e
|
|
2182
|
-
puts "Error when calling PartnersApi->
|
|
2182
|
+
puts "Error when calling PartnersApi->rotate_partner_webhook_secret_with_http_info: #{e}"
|
|
2183
2183
|
end
|
|
2184
2184
|
```
|
|
2185
2185
|
|
|
@@ -2204,9 +2204,9 @@ end
|
|
|
2204
2204
|
- **Accept**: application/json
|
|
2205
2205
|
|
|
2206
2206
|
|
|
2207
|
-
##
|
|
2207
|
+
## send_partner_notification_test_event
|
|
2208
2208
|
|
|
2209
|
-
> <PartnerNotificationTestEventResultResponse>
|
|
2209
|
+
> <PartnerNotificationTestEventResultResponse> send_partner_notification_test_event(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2210
2210
|
|
|
2211
2211
|
Send a test event to your webhook
|
|
2212
2212
|
|
|
@@ -2230,28 +2230,28 @@ partner_notification_test_event_request = ApiSdkRb::PartnerNotificationTestEvent
|
|
|
2230
2230
|
|
|
2231
2231
|
begin
|
|
2232
2232
|
# Send a test event to your webhook
|
|
2233
|
-
result = api_instance.
|
|
2233
|
+
result = api_instance.send_partner_notification_test_event(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2234
2234
|
p result
|
|
2235
2235
|
rescue ApiSdkRb::ApiError => e
|
|
2236
|
-
puts "Error when calling PartnersApi->
|
|
2236
|
+
puts "Error when calling PartnersApi->send_partner_notification_test_event: #{e}"
|
|
2237
2237
|
end
|
|
2238
2238
|
```
|
|
2239
2239
|
|
|
2240
|
-
#### Using the
|
|
2240
|
+
#### Using the send_partner_notification_test_event_with_http_info variant
|
|
2241
2241
|
|
|
2242
2242
|
This returns an Array which contains the response data, status code and headers.
|
|
2243
2243
|
|
|
2244
|
-
> <Array(<PartnerNotificationTestEventResultResponse>, Integer, Hash)>
|
|
2244
|
+
> <Array(<PartnerNotificationTestEventResultResponse>, Integer, Hash)> send_partner_notification_test_event_with_http_info(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2245
2245
|
|
|
2246
2246
|
```ruby
|
|
2247
2247
|
begin
|
|
2248
2248
|
# Send a test event to your webhook
|
|
2249
|
-
data, status_code, headers = api_instance.
|
|
2249
|
+
data, status_code, headers = api_instance.send_partner_notification_test_event_with_http_info(partner_id, idempotency_key, partner_notification_test_event_request)
|
|
2250
2250
|
p status_code # => 2xx
|
|
2251
2251
|
p headers # => { ... }
|
|
2252
2252
|
p data # => <PartnerNotificationTestEventResultResponse>
|
|
2253
2253
|
rescue ApiSdkRb::ApiError => e
|
|
2254
|
-
puts "Error when calling PartnersApi->
|
|
2254
|
+
puts "Error when calling PartnersApi->send_partner_notification_test_event_with_http_info: #{e}"
|
|
2255
2255
|
end
|
|
2256
2256
|
```
|
|
2257
2257
|
|
|
@@ -2277,9 +2277,9 @@ end
|
|
|
2277
2277
|
- **Accept**: application/json
|
|
2278
2278
|
|
|
2279
2279
|
|
|
2280
|
-
##
|
|
2280
|
+
## set_partner_adapter_connection
|
|
2281
2281
|
|
|
2282
|
-
> <
|
|
2282
|
+
> <AdapterConnectionResponse> set_partner_adapter_connection(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2283
2283
|
|
|
2284
2284
|
Connect an adapter key to a partner
|
|
2285
2285
|
|
|
@@ -2304,28 +2304,28 @@ set_adapter_connection_request = ApiSdkRb::SetAdapterConnectionRequest.new({cred
|
|
|
2304
2304
|
|
|
2305
2305
|
begin
|
|
2306
2306
|
# Connect an adapter key to a partner
|
|
2307
|
-
result = api_instance.
|
|
2307
|
+
result = api_instance.set_partner_adapter_connection(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2308
2308
|
p result
|
|
2309
2309
|
rescue ApiSdkRb::ApiError => e
|
|
2310
|
-
puts "Error when calling PartnersApi->
|
|
2310
|
+
puts "Error when calling PartnersApi->set_partner_adapter_connection: #{e}"
|
|
2311
2311
|
end
|
|
2312
2312
|
```
|
|
2313
2313
|
|
|
2314
|
-
#### Using the
|
|
2314
|
+
#### Using the set_partner_adapter_connection_with_http_info variant
|
|
2315
2315
|
|
|
2316
2316
|
This returns an Array which contains the response data, status code and headers.
|
|
2317
2317
|
|
|
2318
|
-
> <Array(<
|
|
2318
|
+
> <Array(<AdapterConnectionResponse>, Integer, Hash)> set_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2319
2319
|
|
|
2320
2320
|
```ruby
|
|
2321
2321
|
begin
|
|
2322
2322
|
# Connect an adapter key to a partner
|
|
2323
|
-
data, status_code, headers = api_instance.
|
|
2323
|
+
data, status_code, headers = api_instance.set_partner_adapter_connection_with_http_info(partner_id, adapter_id, credential_key, set_adapter_connection_request)
|
|
2324
2324
|
p status_code # => 2xx
|
|
2325
2325
|
p headers # => { ... }
|
|
2326
|
-
p data # => <
|
|
2326
|
+
p data # => <AdapterConnectionResponse>
|
|
2327
2327
|
rescue ApiSdkRb::ApiError => e
|
|
2328
|
-
puts "Error when calling PartnersApi->
|
|
2328
|
+
puts "Error when calling PartnersApi->set_partner_adapter_connection_with_http_info: #{e}"
|
|
2329
2329
|
end
|
|
2330
2330
|
```
|
|
2331
2331
|
|
|
@@ -2340,7 +2340,7 @@ end
|
|
|
2340
2340
|
|
|
2341
2341
|
### Return type
|
|
2342
2342
|
|
|
2343
|
-
[**
|
|
2343
|
+
[**AdapterConnectionResponse**](AdapterConnectionResponse.md)
|
|
2344
2344
|
|
|
2345
2345
|
### Authorization
|
|
2346
2346
|
|
|
@@ -2352,9 +2352,9 @@ end
|
|
|
2352
2352
|
- **Accept**: application/json
|
|
2353
2353
|
|
|
2354
2354
|
|
|
2355
|
-
##
|
|
2355
|
+
## set_partner_data_database
|
|
2356
2356
|
|
|
2357
|
-
> <PartnerDataDatabaseResponse>
|
|
2357
|
+
> <PartnerDataDatabaseResponse> set_partner_data_database(partner_id, set_partner_data_database_request)
|
|
2358
2358
|
|
|
2359
2359
|
Keep the data of a partner's compositions in a Neon database of its own
|
|
2360
2360
|
|
|
@@ -2377,28 +2377,28 @@ set_partner_data_database_request = ApiSdkRb::SetPartnerDataDatabaseRequest.new(
|
|
|
2377
2377
|
|
|
2378
2378
|
begin
|
|
2379
2379
|
# Keep the data of a partner's compositions in a Neon database of its own
|
|
2380
|
-
result = api_instance.
|
|
2380
|
+
result = api_instance.set_partner_data_database(partner_id, set_partner_data_database_request)
|
|
2381
2381
|
p result
|
|
2382
2382
|
rescue ApiSdkRb::ApiError => e
|
|
2383
|
-
puts "Error when calling PartnersApi->
|
|
2383
|
+
puts "Error when calling PartnersApi->set_partner_data_database: #{e}"
|
|
2384
2384
|
end
|
|
2385
2385
|
```
|
|
2386
2386
|
|
|
2387
|
-
#### Using the
|
|
2387
|
+
#### Using the set_partner_data_database_with_http_info variant
|
|
2388
2388
|
|
|
2389
2389
|
This returns an Array which contains the response data, status code and headers.
|
|
2390
2390
|
|
|
2391
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
2391
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> set_partner_data_database_with_http_info(partner_id, set_partner_data_database_request)
|
|
2392
2392
|
|
|
2393
2393
|
```ruby
|
|
2394
2394
|
begin
|
|
2395
2395
|
# Keep the data of a partner's compositions in a Neon database of its own
|
|
2396
|
-
data, status_code, headers = api_instance.
|
|
2396
|
+
data, status_code, headers = api_instance.set_partner_data_database_with_http_info(partner_id, set_partner_data_database_request)
|
|
2397
2397
|
p status_code # => 2xx
|
|
2398
2398
|
p headers # => { ... }
|
|
2399
2399
|
p data # => <PartnerDataDatabaseResponse>
|
|
2400
2400
|
rescue ApiSdkRb::ApiError => e
|
|
2401
|
-
puts "Error when calling PartnersApi->
|
|
2401
|
+
puts "Error when calling PartnersApi->set_partner_data_database_with_http_info: #{e}"
|
|
2402
2402
|
end
|
|
2403
2403
|
```
|
|
2404
2404
|
|
|
@@ -2423,9 +2423,9 @@ end
|
|
|
2423
2423
|
- **Accept**: application/json
|
|
2424
2424
|
|
|
2425
2425
|
|
|
2426
|
-
##
|
|
2426
|
+
## set_partner_design_defaults
|
|
2427
2427
|
|
|
2428
|
-
> <
|
|
2428
|
+
> <DesignDefaultsResponse> set_partner_design_defaults(partner_id, set_partner_design_defaults_request)
|
|
2429
2429
|
|
|
2430
2430
|
Set or clear partner-wide design defaults
|
|
2431
2431
|
|
|
@@ -2448,28 +2448,28 @@ set_partner_design_defaults_request = ApiSdkRb::SetPartnerDesignDefaultsRequest.
|
|
|
2448
2448
|
|
|
2449
2449
|
begin
|
|
2450
2450
|
# Set or clear partner-wide design defaults
|
|
2451
|
-
result = api_instance.
|
|
2451
|
+
result = api_instance.set_partner_design_defaults(partner_id, set_partner_design_defaults_request)
|
|
2452
2452
|
p result
|
|
2453
2453
|
rescue ApiSdkRb::ApiError => e
|
|
2454
|
-
puts "Error when calling PartnersApi->
|
|
2454
|
+
puts "Error when calling PartnersApi->set_partner_design_defaults: #{e}"
|
|
2455
2455
|
end
|
|
2456
2456
|
```
|
|
2457
2457
|
|
|
2458
|
-
#### Using the
|
|
2458
|
+
#### Using the set_partner_design_defaults_with_http_info variant
|
|
2459
2459
|
|
|
2460
2460
|
This returns an Array which contains the response data, status code and headers.
|
|
2461
2461
|
|
|
2462
|
-
> <Array(<
|
|
2462
|
+
> <Array(<DesignDefaultsResponse>, Integer, Hash)> set_partner_design_defaults_with_http_info(partner_id, set_partner_design_defaults_request)
|
|
2463
2463
|
|
|
2464
2464
|
```ruby
|
|
2465
2465
|
begin
|
|
2466
2466
|
# Set or clear partner-wide design defaults
|
|
2467
|
-
data, status_code, headers = api_instance.
|
|
2467
|
+
data, status_code, headers = api_instance.set_partner_design_defaults_with_http_info(partner_id, set_partner_design_defaults_request)
|
|
2468
2468
|
p status_code # => 2xx
|
|
2469
2469
|
p headers # => { ... }
|
|
2470
|
-
p data # => <
|
|
2470
|
+
p data # => <DesignDefaultsResponse>
|
|
2471
2471
|
rescue ApiSdkRb::ApiError => e
|
|
2472
|
-
puts "Error when calling PartnersApi->
|
|
2472
|
+
puts "Error when calling PartnersApi->set_partner_design_defaults_with_http_info: #{e}"
|
|
2473
2473
|
end
|
|
2474
2474
|
```
|
|
2475
2475
|
|
|
@@ -2482,7 +2482,7 @@ end
|
|
|
2482
2482
|
|
|
2483
2483
|
### Return type
|
|
2484
2484
|
|
|
2485
|
-
[**
|
|
2485
|
+
[**DesignDefaultsResponse**](DesignDefaultsResponse.md)
|
|
2486
2486
|
|
|
2487
2487
|
### Authorization
|
|
2488
2488
|
|
|
@@ -2494,9 +2494,9 @@ end
|
|
|
2494
2494
|
- **Accept**: application/json
|
|
2495
2495
|
|
|
2496
2496
|
|
|
2497
|
-
##
|
|
2497
|
+
## set_partner_preset
|
|
2498
2498
|
|
|
2499
|
-
> <PartnerPresetResponse>
|
|
2499
|
+
> <PartnerPresetResponse> set_partner_preset(partner_id, key, set_partner_preset_request)
|
|
2500
2500
|
|
|
2501
2501
|
Make a widget a preset, or replace a preset
|
|
2502
2502
|
|
|
@@ -2520,28 +2520,28 @@ set_partner_preset_request = ApiSdkRb::SetPartnerPresetRequest.new({widget_id: '
|
|
|
2520
2520
|
|
|
2521
2521
|
begin
|
|
2522
2522
|
# Make a widget a preset, or replace a preset
|
|
2523
|
-
result = api_instance.
|
|
2523
|
+
result = api_instance.set_partner_preset(partner_id, key, set_partner_preset_request)
|
|
2524
2524
|
p result
|
|
2525
2525
|
rescue ApiSdkRb::ApiError => e
|
|
2526
|
-
puts "Error when calling PartnersApi->
|
|
2526
|
+
puts "Error when calling PartnersApi->set_partner_preset: #{e}"
|
|
2527
2527
|
end
|
|
2528
2528
|
```
|
|
2529
2529
|
|
|
2530
|
-
#### Using the
|
|
2530
|
+
#### Using the set_partner_preset_with_http_info variant
|
|
2531
2531
|
|
|
2532
2532
|
This returns an Array which contains the response data, status code and headers.
|
|
2533
2533
|
|
|
2534
|
-
> <Array(<PartnerPresetResponse>, Integer, Hash)>
|
|
2534
|
+
> <Array(<PartnerPresetResponse>, Integer, Hash)> set_partner_preset_with_http_info(partner_id, key, set_partner_preset_request)
|
|
2535
2535
|
|
|
2536
2536
|
```ruby
|
|
2537
2537
|
begin
|
|
2538
2538
|
# Make a widget a preset, or replace a preset
|
|
2539
|
-
data, status_code, headers = api_instance.
|
|
2539
|
+
data, status_code, headers = api_instance.set_partner_preset_with_http_info(partner_id, key, set_partner_preset_request)
|
|
2540
2540
|
p status_code # => 2xx
|
|
2541
2541
|
p headers # => { ... }
|
|
2542
2542
|
p data # => <PartnerPresetResponse>
|
|
2543
2543
|
rescue ApiSdkRb::ApiError => e
|
|
2544
|
-
puts "Error when calling PartnersApi->
|
|
2544
|
+
puts "Error when calling PartnersApi->set_partner_preset_with_http_info: #{e}"
|
|
2545
2545
|
end
|
|
2546
2546
|
```
|
|
2547
2547
|
|
|
@@ -2567,13 +2567,13 @@ end
|
|
|
2567
2567
|
- **Accept**: application/json
|
|
2568
2568
|
|
|
2569
2569
|
|
|
2570
|
-
##
|
|
2570
|
+
## set_partner_storage_destination
|
|
2571
2571
|
|
|
2572
|
-
> <PartnerStorageDestinationResponse>
|
|
2572
|
+
> <PartnerStorageDestinationResponse> set_partner_storage_destination(partner_id, set_partner_storage_destination_request)
|
|
2573
2573
|
|
|
2574
2574
|
Set where a partner's uploaded files are stored
|
|
2575
2575
|
|
|
2576
|
-
Points the partner at a bucket of its own on an S3-compatible service (Cloudflare R2, Amazon S3, Wasabi, MinIO and the like). From then on, every file the account that administers the partner stores is kept in that bucket instead of with Widgetic, whichever way it arrives: a file sent with `
|
|
2576
|
+
Points the partner at a bucket of its own on an S3-compatible service (Cloudflare R2, Amazon S3, Wasabi, MinIO and the like). From then on, every file the account that administers the partner stores is kept in that bucket instead of with Widgetic, whichever way it arrives: a file sent with `uploadFile` (with an API key, an SDK token, an editor session or from the Widgetic website), a resumable upload, the media library, and the files the agent tools and the MCP server save. It takes none of the account's storage allowance, and its `url` is served from `publicBaseUrl`. The chunks of a resumable upload wait in Widgetic's temporary staging area until it is completed and are removed then: the finished file is stored in your bucket and nowhere else. A destination is required. Partner storage is not optional: your customers' files, and your own however they arrive, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination (on any route, including a resumable upload, which is refused when it is started) is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<keyPrefix>widgetic-check/`, reads it back from `<publicBaseUrl>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `publicBaseUrl`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner's.
|
|
2577
2577
|
|
|
2578
2578
|
### Examples
|
|
2579
2579
|
|
|
@@ -2592,28 +2592,28 @@ set_partner_storage_destination_request = ApiSdkRb::SetPartnerStorageDestination
|
|
|
2592
2592
|
|
|
2593
2593
|
begin
|
|
2594
2594
|
# Set where a partner's uploaded files are stored
|
|
2595
|
-
result = api_instance.
|
|
2595
|
+
result = api_instance.set_partner_storage_destination(partner_id, set_partner_storage_destination_request)
|
|
2596
2596
|
p result
|
|
2597
2597
|
rescue ApiSdkRb::ApiError => e
|
|
2598
|
-
puts "Error when calling PartnersApi->
|
|
2598
|
+
puts "Error when calling PartnersApi->set_partner_storage_destination: #{e}"
|
|
2599
2599
|
end
|
|
2600
2600
|
```
|
|
2601
2601
|
|
|
2602
|
-
#### Using the
|
|
2602
|
+
#### Using the set_partner_storage_destination_with_http_info variant
|
|
2603
2603
|
|
|
2604
2604
|
This returns an Array which contains the response data, status code and headers.
|
|
2605
2605
|
|
|
2606
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
2606
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> set_partner_storage_destination_with_http_info(partner_id, set_partner_storage_destination_request)
|
|
2607
2607
|
|
|
2608
2608
|
```ruby
|
|
2609
2609
|
begin
|
|
2610
2610
|
# Set where a partner's uploaded files are stored
|
|
2611
|
-
data, status_code, headers = api_instance.
|
|
2611
|
+
data, status_code, headers = api_instance.set_partner_storage_destination_with_http_info(partner_id, set_partner_storage_destination_request)
|
|
2612
2612
|
p status_code # => 2xx
|
|
2613
2613
|
p headers # => { ... }
|
|
2614
2614
|
p data # => <PartnerStorageDestinationResponse>
|
|
2615
2615
|
rescue ApiSdkRb::ApiError => e
|
|
2616
|
-
puts "Error when calling PartnersApi->
|
|
2616
|
+
puts "Error when calling PartnersApi->set_partner_storage_destination_with_http_info: #{e}"
|
|
2617
2617
|
end
|
|
2618
2618
|
```
|
|
2619
2619
|
|
|
@@ -2638,9 +2638,9 @@ end
|
|
|
2638
2638
|
- **Accept**: application/json
|
|
2639
2639
|
|
|
2640
2640
|
|
|
2641
|
-
##
|
|
2641
|
+
## set_partner_workflow_preset
|
|
2642
2642
|
|
|
2643
|
-
> <SetPartnerWorkflowPreset200Response>
|
|
2643
|
+
> <SetPartnerWorkflowPreset200Response> set_partner_workflow_preset(partner_id, key, offer_workflow_preset_request)
|
|
2644
2644
|
|
|
2645
2645
|
Offer a workflow as a place to start, or replace what a key offers
|
|
2646
2646
|
|
|
@@ -2664,28 +2664,28 @@ offer_workflow_preset_request = ApiSdkRb::OfferWorkflowPresetRequest.new({workfl
|
|
|
2664
2664
|
|
|
2665
2665
|
begin
|
|
2666
2666
|
# Offer a workflow as a place to start, or replace what a key offers
|
|
2667
|
-
result = api_instance.
|
|
2667
|
+
result = api_instance.set_partner_workflow_preset(partner_id, key, offer_workflow_preset_request)
|
|
2668
2668
|
p result
|
|
2669
2669
|
rescue ApiSdkRb::ApiError => e
|
|
2670
|
-
puts "Error when calling PartnersApi->
|
|
2670
|
+
puts "Error when calling PartnersApi->set_partner_workflow_preset: #{e}"
|
|
2671
2671
|
end
|
|
2672
2672
|
```
|
|
2673
2673
|
|
|
2674
|
-
#### Using the
|
|
2674
|
+
#### Using the set_partner_workflow_preset_with_http_info variant
|
|
2675
2675
|
|
|
2676
2676
|
This returns an Array which contains the response data, status code and headers.
|
|
2677
2677
|
|
|
2678
|
-
> <Array(<SetPartnerWorkflowPreset200Response>, Integer, Hash)>
|
|
2678
|
+
> <Array(<SetPartnerWorkflowPreset200Response>, Integer, Hash)> set_partner_workflow_preset_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
2679
2679
|
|
|
2680
2680
|
```ruby
|
|
2681
2681
|
begin
|
|
2682
2682
|
# Offer a workflow as a place to start, or replace what a key offers
|
|
2683
|
-
data, status_code, headers = api_instance.
|
|
2683
|
+
data, status_code, headers = api_instance.set_partner_workflow_preset_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
2684
2684
|
p status_code # => 2xx
|
|
2685
2685
|
p headers # => { ... }
|
|
2686
2686
|
p data # => <SetPartnerWorkflowPreset200Response>
|
|
2687
2687
|
rescue ApiSdkRb::ApiError => e
|
|
2688
|
-
puts "Error when calling PartnersApi->
|
|
2688
|
+
puts "Error when calling PartnersApi->set_partner_workflow_preset_with_http_info: #{e}"
|
|
2689
2689
|
end
|
|
2690
2690
|
```
|
|
2691
2691
|
|
|
@@ -2711,9 +2711,9 @@ end
|
|
|
2711
2711
|
- **Accept**: application/json
|
|
2712
2712
|
|
|
2713
2713
|
|
|
2714
|
-
##
|
|
2714
|
+
## update_partner_entry_context_signing
|
|
2715
2715
|
|
|
2716
|
-
> <PartnerEntryContextSigningResponse>
|
|
2716
|
+
> <PartnerEntryContextSigningResponse> update_partner_entry_context_signing(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2717
2717
|
|
|
2718
2718
|
Require a signed context, or stop requiring it
|
|
2719
2719
|
|
|
@@ -2739,28 +2739,28 @@ opts = {
|
|
|
2739
2739
|
|
|
2740
2740
|
begin
|
|
2741
2741
|
# Require a signed context, or stop requiring it
|
|
2742
|
-
result = api_instance.
|
|
2742
|
+
result = api_instance.update_partner_entry_context_signing(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2743
2743
|
p result
|
|
2744
2744
|
rescue ApiSdkRb::ApiError => e
|
|
2745
|
-
puts "Error when calling PartnersApi->
|
|
2745
|
+
puts "Error when calling PartnersApi->update_partner_entry_context_signing: #{e}"
|
|
2746
2746
|
end
|
|
2747
2747
|
```
|
|
2748
2748
|
|
|
2749
|
-
#### Using the
|
|
2749
|
+
#### Using the update_partner_entry_context_signing_with_http_info variant
|
|
2750
2750
|
|
|
2751
2751
|
This returns an Array which contains the response data, status code and headers.
|
|
2752
2752
|
|
|
2753
|
-
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)>
|
|
2753
|
+
> <Array(<PartnerEntryContextSigningResponse>, Integer, Hash)> update_partner_entry_context_signing_with_http_info(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2754
2754
|
|
|
2755
2755
|
```ruby
|
|
2756
2756
|
begin
|
|
2757
2757
|
# Require a signed context, or stop requiring it
|
|
2758
|
-
data, status_code, headers = api_instance.
|
|
2758
|
+
data, status_code, headers = api_instance.update_partner_entry_context_signing_with_http_info(partner_id, update_partner_entry_context_signing_request, opts)
|
|
2759
2759
|
p status_code # => 2xx
|
|
2760
2760
|
p headers # => { ... }
|
|
2761
2761
|
p data # => <PartnerEntryContextSigningResponse>
|
|
2762
2762
|
rescue ApiSdkRb::ApiError => e
|
|
2763
|
-
puts "Error when calling PartnersApi->
|
|
2763
|
+
puts "Error when calling PartnersApi->update_partner_entry_context_signing_with_http_info: #{e}"
|
|
2764
2764
|
end
|
|
2765
2765
|
```
|
|
2766
2766
|
|
|
@@ -2786,9 +2786,9 @@ end
|
|
|
2786
2786
|
- **Accept**: application/json
|
|
2787
2787
|
|
|
2788
2788
|
|
|
2789
|
-
##
|
|
2789
|
+
## update_partner_notification_settings
|
|
2790
2790
|
|
|
2791
|
-
> <PartnerNotificationSettingsChangeResponse>
|
|
2791
|
+
> <PartnerNotificationSettingsChangeResponse> update_partner_notification_settings(partner_id, update_partner_notification_settings_request, opts)
|
|
2792
2792
|
|
|
2793
2793
|
Choose where your notifications go
|
|
2794
2794
|
|
|
@@ -2814,28 +2814,28 @@ opts = {
|
|
|
2814
2814
|
|
|
2815
2815
|
begin
|
|
2816
2816
|
# Choose where your notifications go
|
|
2817
|
-
result = api_instance.
|
|
2817
|
+
result = api_instance.update_partner_notification_settings(partner_id, update_partner_notification_settings_request, opts)
|
|
2818
2818
|
p result
|
|
2819
2819
|
rescue ApiSdkRb::ApiError => e
|
|
2820
|
-
puts "Error when calling PartnersApi->
|
|
2820
|
+
puts "Error when calling PartnersApi->update_partner_notification_settings: #{e}"
|
|
2821
2821
|
end
|
|
2822
2822
|
```
|
|
2823
2823
|
|
|
2824
|
-
#### Using the
|
|
2824
|
+
#### Using the update_partner_notification_settings_with_http_info variant
|
|
2825
2825
|
|
|
2826
2826
|
This returns an Array which contains the response data, status code and headers.
|
|
2827
2827
|
|
|
2828
|
-
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)>
|
|
2828
|
+
> <Array(<PartnerNotificationSettingsChangeResponse>, Integer, Hash)> update_partner_notification_settings_with_http_info(partner_id, update_partner_notification_settings_request, opts)
|
|
2829
2829
|
|
|
2830
2830
|
```ruby
|
|
2831
2831
|
begin
|
|
2832
2832
|
# Choose where your notifications go
|
|
2833
|
-
data, status_code, headers = api_instance.
|
|
2833
|
+
data, status_code, headers = api_instance.update_partner_notification_settings_with_http_info(partner_id, update_partner_notification_settings_request, opts)
|
|
2834
2834
|
p status_code # => 2xx
|
|
2835
2835
|
p headers # => { ... }
|
|
2836
2836
|
p data # => <PartnerNotificationSettingsChangeResponse>
|
|
2837
2837
|
rescue ApiSdkRb::ApiError => e
|
|
2838
|
-
puts "Error when calling PartnersApi->
|
|
2838
|
+
puts "Error when calling PartnersApi->update_partner_notification_settings_with_http_info: #{e}"
|
|
2839
2839
|
end
|
|
2840
2840
|
```
|
|
2841
2841
|
|
|
@@ -2861,9 +2861,9 @@ end
|
|
|
2861
2861
|
- **Accept**: application/json
|
|
2862
2862
|
|
|
2863
2863
|
|
|
2864
|
-
##
|
|
2864
|
+
## verify_partner_data_database
|
|
2865
2865
|
|
|
2866
|
-
> <PartnerDataDatabaseResponse>
|
|
2866
|
+
> <PartnerDataDatabaseResponse> verify_partner_data_database(partner_id)
|
|
2867
2867
|
|
|
2868
2868
|
Check that a partner's own database still works
|
|
2869
2869
|
|
|
@@ -2885,28 +2885,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
2885
2885
|
|
|
2886
2886
|
begin
|
|
2887
2887
|
# Check that a partner's own database still works
|
|
2888
|
-
result = api_instance.
|
|
2888
|
+
result = api_instance.verify_partner_data_database(partner_id)
|
|
2889
2889
|
p result
|
|
2890
2890
|
rescue ApiSdkRb::ApiError => e
|
|
2891
|
-
puts "Error when calling PartnersApi->
|
|
2891
|
+
puts "Error when calling PartnersApi->verify_partner_data_database: #{e}"
|
|
2892
2892
|
end
|
|
2893
2893
|
```
|
|
2894
2894
|
|
|
2895
|
-
#### Using the
|
|
2895
|
+
#### Using the verify_partner_data_database_with_http_info variant
|
|
2896
2896
|
|
|
2897
2897
|
This returns an Array which contains the response data, status code and headers.
|
|
2898
2898
|
|
|
2899
|
-
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)>
|
|
2899
|
+
> <Array(<PartnerDataDatabaseResponse>, Integer, Hash)> verify_partner_data_database_with_http_info(partner_id)
|
|
2900
2900
|
|
|
2901
2901
|
```ruby
|
|
2902
2902
|
begin
|
|
2903
2903
|
# Check that a partner's own database still works
|
|
2904
|
-
data, status_code, headers = api_instance.
|
|
2904
|
+
data, status_code, headers = api_instance.verify_partner_data_database_with_http_info(partner_id)
|
|
2905
2905
|
p status_code # => 2xx
|
|
2906
2906
|
p headers # => { ... }
|
|
2907
2907
|
p data # => <PartnerDataDatabaseResponse>
|
|
2908
2908
|
rescue ApiSdkRb::ApiError => e
|
|
2909
|
-
puts "Error when calling PartnersApi->
|
|
2909
|
+
puts "Error when calling PartnersApi->verify_partner_data_database_with_http_info: #{e}"
|
|
2910
2910
|
end
|
|
2911
2911
|
```
|
|
2912
2912
|
|
|
@@ -2930,9 +2930,9 @@ end
|
|
|
2930
2930
|
- **Accept**: application/json
|
|
2931
2931
|
|
|
2932
2932
|
|
|
2933
|
-
##
|
|
2933
|
+
## verify_partner_storage_destination
|
|
2934
2934
|
|
|
2935
|
-
> <PartnerStorageDestinationResponse>
|
|
2935
|
+
> <PartnerStorageDestinationResponse> verify_partner_storage_destination(partner_id)
|
|
2936
2936
|
|
|
2937
2937
|
Check that a partner's storage destination still works
|
|
2938
2938
|
|
|
@@ -2954,28 +2954,28 @@ partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose
|
|
|
2954
2954
|
|
|
2955
2955
|
begin
|
|
2956
2956
|
# Check that a partner's storage destination still works
|
|
2957
|
-
result = api_instance.
|
|
2957
|
+
result = api_instance.verify_partner_storage_destination(partner_id)
|
|
2958
2958
|
p result
|
|
2959
2959
|
rescue ApiSdkRb::ApiError => e
|
|
2960
|
-
puts "Error when calling PartnersApi->
|
|
2960
|
+
puts "Error when calling PartnersApi->verify_partner_storage_destination: #{e}"
|
|
2961
2961
|
end
|
|
2962
2962
|
```
|
|
2963
2963
|
|
|
2964
|
-
#### Using the
|
|
2964
|
+
#### Using the verify_partner_storage_destination_with_http_info variant
|
|
2965
2965
|
|
|
2966
2966
|
This returns an Array which contains the response data, status code and headers.
|
|
2967
2967
|
|
|
2968
|
-
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)>
|
|
2968
|
+
> <Array(<PartnerStorageDestinationResponse>, Integer, Hash)> verify_partner_storage_destination_with_http_info(partner_id)
|
|
2969
2969
|
|
|
2970
2970
|
```ruby
|
|
2971
2971
|
begin
|
|
2972
2972
|
# Check that a partner's storage destination still works
|
|
2973
|
-
data, status_code, headers = api_instance.
|
|
2973
|
+
data, status_code, headers = api_instance.verify_partner_storage_destination_with_http_info(partner_id)
|
|
2974
2974
|
p status_code # => 2xx
|
|
2975
2975
|
p headers # => { ... }
|
|
2976
2976
|
p data # => <PartnerStorageDestinationResponse>
|
|
2977
2977
|
rescue ApiSdkRb::ApiError => e
|
|
2978
|
-
puts "Error when calling PartnersApi->
|
|
2978
|
+
puts "Error when calling PartnersApi->verify_partner_storage_destination_with_http_info: #{e}"
|
|
2979
2979
|
end
|
|
2980
2980
|
```
|
|
2981
2981
|
|