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.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +207 -381
  3. data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
  4. data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
  5. data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
  6. data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
  7. data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
  8. data/docs/BrandKitApi.md +74 -74
  9. data/docs/BrandKitTokens.md +2 -0
  10. data/docs/BrandKitView.md +1 -1
  11. data/docs/BrandTextStyle.md +22 -0
  12. data/docs/CanvasesApi.md +45 -45
  13. data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
  14. data/docs/CompositionsApi.md +615 -349
  15. data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
  16. data/docs/CreditsApi.md +20 -20
  17. data/docs/{CreateCompositionFromWidget201Response.md → DeleteUpload200Response.md} +3 -3
  18. data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
  19. data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
  20. data/docs/EntitlementsApi.md +18 -18
  21. data/docs/{OperationsIdGetResponse.md → GetOperationResponse.md} +3 -3
  22. data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
  23. data/docs/GetOperationResponseDataMetadata.md +24 -0
  24. data/docs/InvoicesApi.md +9 -9
  25. data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
  26. data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
  27. data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
  28. data/docs/ManagedUsersApi.md +261 -171
  29. data/docs/OperationsApi.md +11 -11
  30. data/docs/PartnersApi.md +388 -388
  31. data/docs/PatchBrandKitRequest.md +2 -0
  32. data/docs/PublicEmbedApi.md +95 -95
  33. data/docs/PublicWorkflowEventsRequestEventsInner.md +3 -1
  34. data/docs/{GetPublicWorkflow200Response.md → PublicWorkflowResponse.md} +2 -2
  35. data/docs/TokensApi.md +11 -9
  36. data/docs/Upload.md +1 -1
  37. data/docs/UploadLimits.md +3 -3
  38. data/docs/UploadsApi.md +85 -85
  39. data/docs/UsersApi.md +125 -125
  40. data/docs/WidgetClarification.md +22 -0
  41. data/docs/WidgetClarificationOption.md +22 -0
  42. data/docs/WidgetClarificationQuestion.md +26 -0
  43. data/docs/WidgetNextStep.md +24 -0
  44. data/docs/WidgetPlan.md +26 -0
  45. data/docs/WidgetPlanDecisions.md +32 -0
  46. data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
  47. data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
  48. data/docs/WidgetPlanDecisionsResponsive.md +22 -0
  49. data/docs/WidgetPlanTask.md +24 -0
  50. data/docs/WidgetsApi.md +38 -38
  51. data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md} +2 -2
  52. data/docs/WorkflowFailureReason.md +15 -0
  53. data/docs/WorkflowFailureReasonCounter.md +22 -0
  54. data/docs/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md} +2 -2
  55. data/docs/WorkflowStats.md +4 -2
  56. data/docs/WorkflowsApi.md +197 -413
  57. data/lib/api-sdk-rb/api/brand_kit_api.rb +61 -61
  58. data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
  59. data/lib/api-sdk-rb/api/compositions_api.rb +770 -441
  60. data/lib/api-sdk-rb/api/credits_api.rb +20 -20
  61. data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
  62. data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
  63. data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
  64. data/lib/api-sdk-rb/api/operations_api.rb +10 -10
  65. data/lib/api-sdk-rb/api/partners_api.rb +389 -389
  66. data/lib/api-sdk-rb/api/public_embed_api.rb +95 -95
  67. data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
  68. data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
  69. data/lib/api-sdk-rb/api/users_api.rb +132 -132
  70. data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
  71. data/lib/api-sdk-rb/api/workflows_api.rb +246 -468
  72. data/lib/api-sdk-rb/configuration.rb +0 -60
  73. data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
  74. data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
  75. data/lib/api-sdk-rb/models/{save_workspace_workflow200_response.rb → adapter_connection_removal_response.rb} +4 -4
  76. data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → adapter_connection_response.rb} +3 -3
  77. data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → ai_answers_knowledge_document_response.rb} +3 -3
  78. data/lib/api-sdk-rb/models/brand_kit_tokens.rb +33 -2
  79. data/lib/api-sdk-rb/models/brand_kit_view.rb +1 -1
  80. data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
  81. data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
  82. data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → content_item_write_result_response.rb} +3 -3
  83. data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
  84. data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
  85. data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → design_defaults_response.rb} +3 -3
  86. data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
  87. data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
  88. data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
  89. data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
  90. data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
  91. data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
  92. data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +32 -1
  93. data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +26 -4
  94. data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb} +3 -3
  95. data/lib/api-sdk-rb/models/upload.rb +1 -1
  96. data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
  97. data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
  98. data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → widget_clarification_option.rb} +40 -30
  99. data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
  100. data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
  101. data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
  102. data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
  103. data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
  104. data/lib/api-sdk-rb/models/{create_workspace_workflow_from_preset201_response.rb → widget_plan_decisions_libraries_inner.rb} +39 -30
  105. data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
  106. data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
  107. data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → workflow_detail_response.rb} +4 -4
  108. data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
  109. data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
  110. data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
  111. data/lib/api-sdk-rb/models/workflow_stats.rb +17 -5
  112. data/lib/api-sdk-rb/version.rb +1 -1
  113. data/lib/api-sdk-rb.rb +32 -21
  114. data/spec/api/brand_kit_api_spec.rb +18 -18
  115. data/spec/api/canvases_api_spec.rb +10 -10
  116. data/spec/api/compositions_api_spec.rb +144 -83
  117. data/spec/api/credits_api_spec.rb +5 -5
  118. data/spec/api/entitlements_api_spec.rb +4 -4
  119. data/spec/api/invoices_api_spec.rb +2 -2
  120. data/spec/api/managed_users_api_spec.rb +63 -42
  121. data/spec/api/operations_api_spec.rb +3 -3
  122. data/spec/api/partners_api_spec.rb +91 -91
  123. data/spec/api/public_embed_api_spec.rb +23 -23
  124. data/spec/api/tokens_api_spec.rb +3 -2
  125. data/spec/api/uploads_api_spec.rb +24 -24
  126. data/spec/api/users_api_spec.rb +30 -30
  127. data/spec/api/widgets_api_spec.rb +9 -9
  128. data/spec/api/workflows_api_spec.rb +50 -89
  129. data/spec/models/{get_user_adapter_connections200_response_spec.rb → account_credit_transaction_list_response_spec.rb} +6 -6
  130. data/spec/models/{get_public_workflow200_response_spec.rb → adapter_connection_list_response_spec.rb} +6 -6
  131. data/spec/models/{save_workspace_workflow200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
  132. data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
  133. data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
  134. data/spec/models/brand_kit_tokens_spec.rb +6 -0
  135. data/spec/models/{create_composition_from_widget201_response_spec.rb → brand_text_style_spec.rb} +13 -9
  136. data/spec/models/{get_managed_user_limits200_response_spec.rb → composition_database_record_response_spec.rb} +6 -6
  137. data/spec/models/content_item_write_result_response_spec.rb +48 -0
  138. data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
  139. data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
  140. data/spec/models/design_defaults_response_spec.rb +48 -0
  141. data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
  142. data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
  143. data/spec/models/{uploads_get200_response_spec.rb → get_operation_response_spec.rb} +6 -6
  144. data/spec/models/list_uploads200_response_spec.rb +48 -0
  145. data/spec/models/managed_user_limits_response_spec.rb +48 -0
  146. data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
  147. data/spec/models/patch_brand_kit_request_spec.rb +6 -0
  148. data/spec/models/public_workflow_events_request_events_inner_spec.rb +10 -0
  149. data/spec/models/public_workflow_response_spec.rb +48 -0
  150. data/spec/models/widget_clarification_option_spec.rb +48 -0
  151. data/spec/models/widget_clarification_question_spec.rb +60 -0
  152. data/spec/models/widget_clarification_spec.rb +48 -0
  153. data/spec/models/widget_next_step_spec.rb +58 -0
  154. data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
  155. data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
  156. data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
  157. data/spec/models/widget_plan_decisions_spec.rb +78 -0
  158. data/spec/models/{create_composition_database_record201_response_spec.rb → widget_plan_spec.rb} +21 -9
  159. data/spec/models/widget_plan_task_spec.rb +62 -0
  160. data/spec/models/workflow_detail_response_spec.rb +48 -0
  161. data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
  162. data/spec/models/workflow_failure_reason_spec.rb +30 -0
  163. data/spec/models/workflow_response_spec.rb +48 -0
  164. data/spec/models/workflow_stats_spec.rb +6 -0
  165. metadata +130 -86
  166. data/docs/PartnerApi.md +0 -12714
  167. data/docs/UploadsIdDelete200Response.md +0 -22
  168. data/docs/WorkspacesApi.md +0 -1527
  169. data/lib/api-sdk-rb/api/partner_api.rb +0 -13791
  170. data/lib/api-sdk-rb/api/workspaces_api.rb +0 -1775
  171. data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +0 -246
  172. data/spec/api/partner_api_spec.rb +0 -2437
  173. data/spec/api/workspaces_api_spec.rb +0 -339
  174. data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +0 -48
  175. data/spec/models/create_composition_content_item201_response_spec.rb +0 -48
  176. data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +0 -48
  177. data/spec/models/get_partner_credit_transactions200_response_spec.rb +0 -48
  178. data/spec/models/get_partner_design_defaults200_response_spec.rb +0 -48
  179. data/spec/models/remove_user_adapter_connection200_response_spec.rb +0 -48
  180. data/spec/models/set_user_adapter_connection200_response_spec.rb +0 -48
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **colors** | [**Array<BrandColor>**](BrandColor.md) | The whole list of colors (it replaces the saved list). | [optional] |
8
8
  | **fonts** | [**PatchBrandKitRequestFonts**](PatchBrandKitRequestFonts.md) | | [optional] |
9
+ | **text_styles** | [**Array<BrandTextStyle>**](BrandTextStyle.md) | The whole list of text styles (it replaces the saved list). An empty list removes them, and the fonts by role apply again. Left out, the saved text styles stay as they are. | [optional] |
9
10
  | **spacing** | [**PatchBrandKitRequestSpacing**](PatchBrandKitRequestSpacing.md) | | [optional] |
10
11
  | **corner_radius** | **Integer** | One corner radius in pixels for the whole kit; the small, medium and large radii are made from it. 0 gives square corners. A radius step sent in `spacing` wins over the one made from this value. | [optional] |
11
12
  | **instructions** | **String** | The kit owner's style notes (see `tokens.instructions`). An empty string removes them. | [optional] |
@@ -19,6 +20,7 @@ require 'api-sdk-rb'
19
20
  instance = ApiSdkRb::PatchBrandKitRequest.new(
20
21
  colors: null,
21
22
  fonts: null,
23
+ text_styles: null,
22
24
  spacing: null,
23
25
  corner_radius: null,
24
26
  instructions: null,
@@ -4,21 +4,21 @@ All URIs are relative to *https://api.widgetic.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**call_public_composition_adapter_0**](PublicEmbedApi.md#call_public_composition_adapter_0) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses |
8
- | [**create_public_composition_entry_0**](PublicEmbedApi.md#create_public_composition_entry_0) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway |
9
- | [**get_public_composition_embed_0**](PublicEmbedApi.md#get_public_composition_embed_0) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL |
10
- | [**get_public_composition_iframe_0**](PublicEmbedApi.md#get_public_composition_iframe_0) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values |
11
- | [**get_public_workflow_0**](PublicEmbedApi.md#get_public_workflow_0) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed |
12
- | [**get_public_workflow_frame_0**](PublicEmbedApi.md#get_public_workflow_frame_0) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own |
13
- | [**get_public_workflow_version_0**](PublicEmbedApi.md#get_public_workflow_version_0) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow |
14
- | [**post_public_composition_embed_status_0**](PublicEmbedApi.md#post_public_composition_embed_status_0) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed |
15
- | [**report_public_workflow_events_0**](PublicEmbedApi.md#report_public_workflow_events_0) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts |
16
- | [**upload_public_composition_adapter_file_0**](PublicEmbedApi.md#upload_public_composition_adapter_file_0) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget |
7
+ | [**call_public_composition_adapter**](PublicEmbedApi.md#call_public_composition_adapter) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses |
8
+ | [**create_public_composition_entry**](PublicEmbedApi.md#create_public_composition_entry) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway |
9
+ | [**get_public_composition_embed**](PublicEmbedApi.md#get_public_composition_embed) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL |
10
+ | [**get_public_composition_iframe**](PublicEmbedApi.md#get_public_composition_iframe) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values |
11
+ | [**get_public_workflow**](PublicEmbedApi.md#get_public_workflow) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed |
12
+ | [**get_public_workflow_frame**](PublicEmbedApi.md#get_public_workflow_frame) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own |
13
+ | [**get_public_workflow_version**](PublicEmbedApi.md#get_public_workflow_version) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow |
14
+ | [**post_public_composition_embed_status**](PublicEmbedApi.md#post_public_composition_embed_status) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed |
15
+ | [**report_public_workflow_events**](PublicEmbedApi.md#report_public_workflow_events) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts |
16
+ | [**upload_public_composition_adapter_file**](PublicEmbedApi.md#upload_public_composition_adapter_file) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget |
17
17
 
18
18
 
19
- ## call_public_composition_adapter_0
19
+ ## call_public_composition_adapter
20
20
 
21
- > <PublicAdapterCallResult> call_public_composition_adapter_0(composition_id, adapter_id, operation, public_adapter_call_request)
21
+ > <PublicAdapterCallResult> call_public_composition_adapter(composition_id, adapter_id, operation, public_adapter_call_request)
22
22
 
23
23
  Call a gateway operation of an adapter a published widget uses
24
24
 
@@ -38,28 +38,28 @@ public_adapter_call_request = ApiSdkRb::PublicAdapterCallRequest.new({request_id
38
38
 
39
39
  begin
40
40
  # Call a gateway operation of an adapter a published widget uses
41
- result = api_instance.call_public_composition_adapter_0(composition_id, adapter_id, operation, public_adapter_call_request)
41
+ result = api_instance.call_public_composition_adapter(composition_id, adapter_id, operation, public_adapter_call_request)
42
42
  p result
43
43
  rescue ApiSdkRb::ApiError => e
44
- puts "Error when calling PublicEmbedApi->call_public_composition_adapter_0: #{e}"
44
+ puts "Error when calling PublicEmbedApi->call_public_composition_adapter: #{e}"
45
45
  end
46
46
  ```
47
47
 
48
- #### Using the call_public_composition_adapter_0_with_http_info variant
48
+ #### Using the call_public_composition_adapter_with_http_info variant
49
49
 
50
50
  This returns an Array which contains the response data, status code and headers.
51
51
 
52
- > <Array(<PublicAdapterCallResult>, Integer, Hash)> call_public_composition_adapter_0_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request)
52
+ > <Array(<PublicAdapterCallResult>, Integer, Hash)> call_public_composition_adapter_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request)
53
53
 
54
54
  ```ruby
55
55
  begin
56
56
  # Call a gateway operation of an adapter a published widget uses
57
- data, status_code, headers = api_instance.call_public_composition_adapter_0_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request)
57
+ data, status_code, headers = api_instance.call_public_composition_adapter_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request)
58
58
  p status_code # => 2xx
59
59
  p headers # => { ... }
60
60
  p data # => <PublicAdapterCallResult>
61
61
  rescue ApiSdkRb::ApiError => e
62
- puts "Error when calling PublicEmbedApi->call_public_composition_adapter_0_with_http_info: #{e}"
62
+ puts "Error when calling PublicEmbedApi->call_public_composition_adapter_with_http_info: #{e}"
63
63
  end
64
64
  ```
65
65
 
@@ -86,9 +86,9 @@ No authorization required
86
86
  - **Accept**: application/json
87
87
 
88
88
 
89
- ## create_public_composition_entry_0
89
+ ## create_public_composition_entry
90
90
 
91
- > <PublicCompositionEntryCreated> create_public_composition_entry_0(composition_id, table, public_composition_entry_request, opts)
91
+ > <PublicCompositionEntryCreated> create_public_composition_entry(composition_id, table, public_composition_entry_request, opts)
92
92
 
93
93
  Append a visitor entry through the gateway
94
94
 
@@ -111,28 +111,28 @@ opts = {
111
111
 
112
112
  begin
113
113
  # Append a visitor entry through the gateway
114
- result = api_instance.create_public_composition_entry_0(composition_id, table, public_composition_entry_request, opts)
114
+ result = api_instance.create_public_composition_entry(composition_id, table, public_composition_entry_request, opts)
115
115
  p result
116
116
  rescue ApiSdkRb::ApiError => e
117
- puts "Error when calling PublicEmbedApi->create_public_composition_entry_0: #{e}"
117
+ puts "Error when calling PublicEmbedApi->create_public_composition_entry: #{e}"
118
118
  end
119
119
  ```
120
120
 
121
- #### Using the create_public_composition_entry_0_with_http_info variant
121
+ #### Using the create_public_composition_entry_with_http_info variant
122
122
 
123
123
  This returns an Array which contains the response data, status code and headers.
124
124
 
125
- > <Array(<PublicCompositionEntryCreated>, Integer, Hash)> create_public_composition_entry_0_with_http_info(composition_id, table, public_composition_entry_request, opts)
125
+ > <Array(<PublicCompositionEntryCreated>, Integer, Hash)> create_public_composition_entry_with_http_info(composition_id, table, public_composition_entry_request, opts)
126
126
 
127
127
  ```ruby
128
128
  begin
129
129
  # Append a visitor entry through the gateway
130
- data, status_code, headers = api_instance.create_public_composition_entry_0_with_http_info(composition_id, table, public_composition_entry_request, opts)
130
+ data, status_code, headers = api_instance.create_public_composition_entry_with_http_info(composition_id, table, public_composition_entry_request, opts)
131
131
  p status_code # => 2xx
132
132
  p headers # => { ... }
133
133
  p data # => <PublicCompositionEntryCreated>
134
134
  rescue ApiSdkRb::ApiError => e
135
- puts "Error when calling PublicEmbedApi->create_public_composition_entry_0_with_http_info: #{e}"
135
+ puts "Error when calling PublicEmbedApi->create_public_composition_entry_with_http_info: #{e}"
136
136
  end
137
137
  ```
138
138
 
@@ -160,9 +160,9 @@ No authorization required
160
160
  - **Accept**: application/json
161
161
 
162
162
 
163
- ## get_public_composition_embed_0
163
+ ## get_public_composition_embed
164
164
 
165
- > <GetPublicCompositionEmbed200Response> get_public_composition_embed_0(composition_id)
165
+ > <GetPublicCompositionEmbed200Response> get_public_composition_embed(composition_id)
166
166
 
167
167
  Resolve a composition UUID to a published widget URL
168
168
 
@@ -179,28 +179,28 @@ composition_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
179
179
 
180
180
  begin
181
181
  # Resolve a composition UUID to a published widget URL
182
- result = api_instance.get_public_composition_embed_0(composition_id)
182
+ result = api_instance.get_public_composition_embed(composition_id)
183
183
  p result
184
184
  rescue ApiSdkRb::ApiError => e
185
- puts "Error when calling PublicEmbedApi->get_public_composition_embed_0: #{e}"
185
+ puts "Error when calling PublicEmbedApi->get_public_composition_embed: #{e}"
186
186
  end
187
187
  ```
188
188
 
189
- #### Using the get_public_composition_embed_0_with_http_info variant
189
+ #### Using the get_public_composition_embed_with_http_info variant
190
190
 
191
191
  This returns an Array which contains the response data, status code and headers.
192
192
 
193
- > <Array(<GetPublicCompositionEmbed200Response>, Integer, Hash)> get_public_composition_embed_0_with_http_info(composition_id)
193
+ > <Array(<GetPublicCompositionEmbed200Response>, Integer, Hash)> get_public_composition_embed_with_http_info(composition_id)
194
194
 
195
195
  ```ruby
196
196
  begin
197
197
  # Resolve a composition UUID to a published widget URL
198
- data, status_code, headers = api_instance.get_public_composition_embed_0_with_http_info(composition_id)
198
+ data, status_code, headers = api_instance.get_public_composition_embed_with_http_info(composition_id)
199
199
  p status_code # => 2xx
200
200
  p headers # => { ... }
201
201
  p data # => <GetPublicCompositionEmbed200Response>
202
202
  rescue ApiSdkRb::ApiError => e
203
- puts "Error when calling PublicEmbedApi->get_public_composition_embed_0_with_http_info: #{e}"
203
+ puts "Error when calling PublicEmbedApi->get_public_composition_embed_with_http_info: #{e}"
204
204
  end
205
205
  ```
206
206
 
@@ -224,9 +224,9 @@ No authorization required
224
224
  - **Accept**: application/json
225
225
 
226
226
 
227
- ## get_public_composition_iframe_0
227
+ ## get_public_composition_iframe
228
228
 
229
- > String get_public_composition_iframe_0(composition_id)
229
+ > String get_public_composition_iframe(composition_id)
230
230
 
231
231
  Embed a published composition with its saved values
232
232
 
@@ -243,28 +243,28 @@ composition_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
243
243
 
244
244
  begin
245
245
  # Embed a published composition with its saved values
246
- result = api_instance.get_public_composition_iframe_0(composition_id)
246
+ result = api_instance.get_public_composition_iframe(composition_id)
247
247
  p result
248
248
  rescue ApiSdkRb::ApiError => e
249
- puts "Error when calling PublicEmbedApi->get_public_composition_iframe_0: #{e}"
249
+ puts "Error when calling PublicEmbedApi->get_public_composition_iframe: #{e}"
250
250
  end
251
251
  ```
252
252
 
253
- #### Using the get_public_composition_iframe_0_with_http_info variant
253
+ #### Using the get_public_composition_iframe_with_http_info variant
254
254
 
255
255
  This returns an Array which contains the response data, status code and headers.
256
256
 
257
- > <Array(String, Integer, Hash)> get_public_composition_iframe_0_with_http_info(composition_id)
257
+ > <Array(String, Integer, Hash)> get_public_composition_iframe_with_http_info(composition_id)
258
258
 
259
259
  ```ruby
260
260
  begin
261
261
  # Embed a published composition with its saved values
262
- data, status_code, headers = api_instance.get_public_composition_iframe_0_with_http_info(composition_id)
262
+ data, status_code, headers = api_instance.get_public_composition_iframe_with_http_info(composition_id)
263
263
  p status_code # => 2xx
264
264
  p headers # => { ... }
265
265
  p data # => String
266
266
  rescue ApiSdkRb::ApiError => e
267
- puts "Error when calling PublicEmbedApi->get_public_composition_iframe_0_with_http_info: #{e}"
267
+ puts "Error when calling PublicEmbedApi->get_public_composition_iframe_with_http_info: #{e}"
268
268
  end
269
269
  ```
270
270
 
@@ -288,9 +288,9 @@ No authorization required
288
288
  - **Accept**: text/html, application/json
289
289
 
290
290
 
291
- ## get_public_workflow_0
291
+ ## get_public_workflow
292
292
 
293
- > <GetPublicWorkflow200Response> get_public_workflow_0(workflow_id)
293
+ > <PublicWorkflowResponse> get_public_workflow(workflow_id)
294
294
 
295
295
  Read the published Workflow of an embed
296
296
 
@@ -307,28 +307,28 @@ workflow_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
307
307
 
308
308
  begin
309
309
  # Read the published Workflow of an embed
310
- result = api_instance.get_public_workflow_0(workflow_id)
310
+ result = api_instance.get_public_workflow(workflow_id)
311
311
  p result
312
312
  rescue ApiSdkRb::ApiError => e
313
- puts "Error when calling PublicEmbedApi->get_public_workflow_0: #{e}"
313
+ puts "Error when calling PublicEmbedApi->get_public_workflow: #{e}"
314
314
  end
315
315
  ```
316
316
 
317
- #### Using the get_public_workflow_0_with_http_info variant
317
+ #### Using the get_public_workflow_with_http_info variant
318
318
 
319
319
  This returns an Array which contains the response data, status code and headers.
320
320
 
321
- > <Array(<GetPublicWorkflow200Response>, Integer, Hash)> get_public_workflow_0_with_http_info(workflow_id)
321
+ > <Array(<PublicWorkflowResponse>, Integer, Hash)> get_public_workflow_with_http_info(workflow_id)
322
322
 
323
323
  ```ruby
324
324
  begin
325
325
  # Read the published Workflow of an embed
326
- data, status_code, headers = api_instance.get_public_workflow_0_with_http_info(workflow_id)
326
+ data, status_code, headers = api_instance.get_public_workflow_with_http_info(workflow_id)
327
327
  p status_code # => 2xx
328
328
  p headers # => { ... }
329
- p data # => <GetPublicWorkflow200Response>
329
+ p data # => <PublicWorkflowResponse>
330
330
  rescue ApiSdkRb::ApiError => e
331
- puts "Error when calling PublicEmbedApi->get_public_workflow_0_with_http_info: #{e}"
331
+ puts "Error when calling PublicEmbedApi->get_public_workflow_with_http_info: #{e}"
332
332
  end
333
333
  ```
334
334
 
@@ -340,7 +340,7 @@ end
340
340
 
341
341
  ### Return type
342
342
 
343
- [**GetPublicWorkflow200Response**](GetPublicWorkflow200Response.md)
343
+ [**PublicWorkflowResponse**](PublicWorkflowResponse.md)
344
344
 
345
345
  ### Authorization
346
346
 
@@ -352,13 +352,13 @@ No authorization required
352
352
  - **Accept**: application/json
353
353
 
354
354
 
355
- ## get_public_workflow_frame_0
355
+ ## get_public_workflow_frame
356
356
 
357
- > String get_public_workflow_frame_0(workflow_id)
357
+ > String get_public_workflow_frame(workflow_id)
358
358
 
359
359
  Show a published Workflow in a page of its own
360
360
 
361
- A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
361
+ A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own, and the website where the partner the owner administers integrates Widgetic, with its subdomains), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
362
362
 
363
363
  ### Examples
364
364
 
@@ -371,28 +371,28 @@ workflow_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
371
371
 
372
372
  begin
373
373
  # Show a published Workflow in a page of its own
374
- result = api_instance.get_public_workflow_frame_0(workflow_id)
374
+ result = api_instance.get_public_workflow_frame(workflow_id)
375
375
  p result
376
376
  rescue ApiSdkRb::ApiError => e
377
- puts "Error when calling PublicEmbedApi->get_public_workflow_frame_0: #{e}"
377
+ puts "Error when calling PublicEmbedApi->get_public_workflow_frame: #{e}"
378
378
  end
379
379
  ```
380
380
 
381
- #### Using the get_public_workflow_frame_0_with_http_info variant
381
+ #### Using the get_public_workflow_frame_with_http_info variant
382
382
 
383
383
  This returns an Array which contains the response data, status code and headers.
384
384
 
385
- > <Array(String, Integer, Hash)> get_public_workflow_frame_0_with_http_info(workflow_id)
385
+ > <Array(String, Integer, Hash)> get_public_workflow_frame_with_http_info(workflow_id)
386
386
 
387
387
  ```ruby
388
388
  begin
389
389
  # Show a published Workflow in a page of its own
390
- data, status_code, headers = api_instance.get_public_workflow_frame_0_with_http_info(workflow_id)
390
+ data, status_code, headers = api_instance.get_public_workflow_frame_with_http_info(workflow_id)
391
391
  p status_code # => 2xx
392
392
  p headers # => { ... }
393
393
  p data # => String
394
394
  rescue ApiSdkRb::ApiError => e
395
- puts "Error when calling PublicEmbedApi->get_public_workflow_frame_0_with_http_info: #{e}"
395
+ puts "Error when calling PublicEmbedApi->get_public_workflow_frame_with_http_info: #{e}"
396
396
  end
397
397
  ```
398
398
 
@@ -416,9 +416,9 @@ No authorization required
416
416
  - **Accept**: text/html, application/json
417
417
 
418
418
 
419
- ## get_public_workflow_version_0
419
+ ## get_public_workflow_version
420
420
 
421
- > <GetPublicWorkflow200Response> get_public_workflow_version_0(workflow_id, version_id)
421
+ > <PublicWorkflowResponse> get_public_workflow_version(workflow_id, version_id)
422
422
 
423
423
  Read one published version of a Workflow
424
424
 
@@ -436,28 +436,28 @@ version_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
436
436
 
437
437
  begin
438
438
  # Read one published version of a Workflow
439
- result = api_instance.get_public_workflow_version_0(workflow_id, version_id)
439
+ result = api_instance.get_public_workflow_version(workflow_id, version_id)
440
440
  p result
441
441
  rescue ApiSdkRb::ApiError => e
442
- puts "Error when calling PublicEmbedApi->get_public_workflow_version_0: #{e}"
442
+ puts "Error when calling PublicEmbedApi->get_public_workflow_version: #{e}"
443
443
  end
444
444
  ```
445
445
 
446
- #### Using the get_public_workflow_version_0_with_http_info variant
446
+ #### Using the get_public_workflow_version_with_http_info variant
447
447
 
448
448
  This returns an Array which contains the response data, status code and headers.
449
449
 
450
- > <Array(<GetPublicWorkflow200Response>, Integer, Hash)> get_public_workflow_version_0_with_http_info(workflow_id, version_id)
450
+ > <Array(<PublicWorkflowResponse>, Integer, Hash)> get_public_workflow_version_with_http_info(workflow_id, version_id)
451
451
 
452
452
  ```ruby
453
453
  begin
454
454
  # Read one published version of a Workflow
455
- data, status_code, headers = api_instance.get_public_workflow_version_0_with_http_info(workflow_id, version_id)
455
+ data, status_code, headers = api_instance.get_public_workflow_version_with_http_info(workflow_id, version_id)
456
456
  p status_code # => 2xx
457
457
  p headers # => { ... }
458
- p data # => <GetPublicWorkflow200Response>
458
+ p data # => <PublicWorkflowResponse>
459
459
  rescue ApiSdkRb::ApiError => e
460
- puts "Error when calling PublicEmbedApi->get_public_workflow_version_0_with_http_info: #{e}"
460
+ puts "Error when calling PublicEmbedApi->get_public_workflow_version_with_http_info: #{e}"
461
461
  end
462
462
  ```
463
463
 
@@ -470,7 +470,7 @@ end
470
470
 
471
471
  ### Return type
472
472
 
473
- [**GetPublicWorkflow200Response**](GetPublicWorkflow200Response.md)
473
+ [**PublicWorkflowResponse**](PublicWorkflowResponse.md)
474
474
 
475
475
  ### Authorization
476
476
 
@@ -482,9 +482,9 @@ No authorization required
482
482
  - **Accept**: application/json
483
483
 
484
484
 
485
- ## post_public_composition_embed_status_0
485
+ ## post_public_composition_embed_status
486
486
 
487
- > <PostPublicCompositionEmbedStatus200Response> post_public_composition_embed_status_0(post_public_composition_embed_status_request)
487
+ > <PostPublicCompositionEmbedStatus200Response> post_public_composition_embed_status(post_public_composition_embed_status_request)
488
488
 
489
489
  Batch-check whether compositions are currently served for embed
490
490
 
@@ -501,28 +501,28 @@ post_public_composition_embed_status_request = ApiSdkRb::PostPublicCompositionEm
501
501
 
502
502
  begin
503
503
  # Batch-check whether compositions are currently served for embed
504
- result = api_instance.post_public_composition_embed_status_0(post_public_composition_embed_status_request)
504
+ result = api_instance.post_public_composition_embed_status(post_public_composition_embed_status_request)
505
505
  p result
506
506
  rescue ApiSdkRb::ApiError => e
507
- puts "Error when calling PublicEmbedApi->post_public_composition_embed_status_0: #{e}"
507
+ puts "Error when calling PublicEmbedApi->post_public_composition_embed_status: #{e}"
508
508
  end
509
509
  ```
510
510
 
511
- #### Using the post_public_composition_embed_status_0_with_http_info variant
511
+ #### Using the post_public_composition_embed_status_with_http_info variant
512
512
 
513
513
  This returns an Array which contains the response data, status code and headers.
514
514
 
515
- > <Array(<PostPublicCompositionEmbedStatus200Response>, Integer, Hash)> post_public_composition_embed_status_0_with_http_info(post_public_composition_embed_status_request)
515
+ > <Array(<PostPublicCompositionEmbedStatus200Response>, Integer, Hash)> post_public_composition_embed_status_with_http_info(post_public_composition_embed_status_request)
516
516
 
517
517
  ```ruby
518
518
  begin
519
519
  # Batch-check whether compositions are currently served for embed
520
- data, status_code, headers = api_instance.post_public_composition_embed_status_0_with_http_info(post_public_composition_embed_status_request)
520
+ data, status_code, headers = api_instance.post_public_composition_embed_status_with_http_info(post_public_composition_embed_status_request)
521
521
  p status_code # => 2xx
522
522
  p headers # => { ... }
523
523
  p data # => <PostPublicCompositionEmbedStatus200Response>
524
524
  rescue ApiSdkRb::ApiError => e
525
- puts "Error when calling PublicEmbedApi->post_public_composition_embed_status_0_with_http_info: #{e}"
525
+ puts "Error when calling PublicEmbedApi->post_public_composition_embed_status_with_http_info: #{e}"
526
526
  end
527
527
  ```
528
528
 
@@ -546,9 +546,9 @@ No authorization required
546
546
  - **Accept**: application/json
547
547
 
548
548
 
549
- ## report_public_workflow_events_0
549
+ ## report_public_workflow_events
550
550
 
551
- > <ReportPublicWorkflowEvents200Response> report_public_workflow_events_0(workflow_id, public_workflow_events_request)
551
+ > <ReportPublicWorkflowEvents200Response> report_public_workflow_events(workflow_id, public_workflow_events_request)
552
552
 
553
553
  Report what visitors did in a Workflow, as counts
554
554
 
@@ -566,28 +566,28 @@ public_workflow_events_request = ApiSdkRb::PublicWorkflowEventsRequest.new({vers
566
566
 
567
567
  begin
568
568
  # Report what visitors did in a Workflow, as counts
569
- result = api_instance.report_public_workflow_events_0(workflow_id, public_workflow_events_request)
569
+ result = api_instance.report_public_workflow_events(workflow_id, public_workflow_events_request)
570
570
  p result
571
571
  rescue ApiSdkRb::ApiError => e
572
- puts "Error when calling PublicEmbedApi->report_public_workflow_events_0: #{e}"
572
+ puts "Error when calling PublicEmbedApi->report_public_workflow_events: #{e}"
573
573
  end
574
574
  ```
575
575
 
576
- #### Using the report_public_workflow_events_0_with_http_info variant
576
+ #### Using the report_public_workflow_events_with_http_info variant
577
577
 
578
578
  This returns an Array which contains the response data, status code and headers.
579
579
 
580
- > <Array(<ReportPublicWorkflowEvents200Response>, Integer, Hash)> report_public_workflow_events_0_with_http_info(workflow_id, public_workflow_events_request)
580
+ > <Array(<ReportPublicWorkflowEvents200Response>, Integer, Hash)> report_public_workflow_events_with_http_info(workflow_id, public_workflow_events_request)
581
581
 
582
582
  ```ruby
583
583
  begin
584
584
  # Report what visitors did in a Workflow, as counts
585
- data, status_code, headers = api_instance.report_public_workflow_events_0_with_http_info(workflow_id, public_workflow_events_request)
585
+ data, status_code, headers = api_instance.report_public_workflow_events_with_http_info(workflow_id, public_workflow_events_request)
586
586
  p status_code # => 2xx
587
587
  p headers # => { ... }
588
588
  p data # => <ReportPublicWorkflowEvents200Response>
589
589
  rescue ApiSdkRb::ApiError => e
590
- puts "Error when calling PublicEmbedApi->report_public_workflow_events_0_with_http_info: #{e}"
590
+ puts "Error when calling PublicEmbedApi->report_public_workflow_events_with_http_info: #{e}"
591
591
  end
592
592
  ```
593
593
 
@@ -612,9 +612,9 @@ No authorization required
612
612
  - **Accept**: application/json
613
613
 
614
614
 
615
- ## upload_public_composition_adapter_file_0
615
+ ## upload_public_composition_adapter_file
616
616
 
617
- > <PublicAdapterFileResult> upload_public_composition_adapter_file_0(composition_id, ticket, body)
617
+ > <PublicAdapterFileResult> upload_public_composition_adapter_file(composition_id, ticket, body)
618
618
 
619
619
  Send the file a visitor chose through the upload adapter of a published widget
620
620
 
@@ -633,28 +633,28 @@ body = File.new('/path/to/some/file') # File |
633
633
 
634
634
  begin
635
635
  # Send the file a visitor chose through the upload adapter of a published widget
636
- result = api_instance.upload_public_composition_adapter_file_0(composition_id, ticket, body)
636
+ result = api_instance.upload_public_composition_adapter_file(composition_id, ticket, body)
637
637
  p result
638
638
  rescue ApiSdkRb::ApiError => e
639
- puts "Error when calling PublicEmbedApi->upload_public_composition_adapter_file_0: #{e}"
639
+ puts "Error when calling PublicEmbedApi->upload_public_composition_adapter_file: #{e}"
640
640
  end
641
641
  ```
642
642
 
643
- #### Using the upload_public_composition_adapter_file_0_with_http_info variant
643
+ #### Using the upload_public_composition_adapter_file_with_http_info variant
644
644
 
645
645
  This returns an Array which contains the response data, status code and headers.
646
646
 
647
- > <Array(<PublicAdapterFileResult>, Integer, Hash)> upload_public_composition_adapter_file_0_with_http_info(composition_id, ticket, body)
647
+ > <Array(<PublicAdapterFileResult>, Integer, Hash)> upload_public_composition_adapter_file_with_http_info(composition_id, ticket, body)
648
648
 
649
649
  ```ruby
650
650
  begin
651
651
  # Send the file a visitor chose through the upload adapter of a published widget
652
- data, status_code, headers = api_instance.upload_public_composition_adapter_file_0_with_http_info(composition_id, ticket, body)
652
+ data, status_code, headers = api_instance.upload_public_composition_adapter_file_with_http_info(composition_id, ticket, body)
653
653
  p status_code # => 2xx
654
654
  p headers # => { ... }
655
655
  p data # => <PublicAdapterFileResult>
656
656
  rescue ApiSdkRb::ApiError => e
657
- puts "Error when calling PublicEmbedApi->upload_public_composition_adapter_file_0_with_http_info: #{e}"
657
+ puts "Error when calling PublicEmbedApi->upload_public_composition_adapter_file_with_http_info: #{e}"
658
658
  end
659
659
  ```
660
660
 
@@ -7,6 +7,7 @@
7
7
  | **k** | **String** | &#x60;n&#x60; a visitor reached a block, &#x60;e&#x60; a visitor took a connection, &#x60;f&#x60; moving a visitor on failed. | |
8
8
  | **id** | **String** | The block or connection counted. | |
9
9
  | **c** | **Integer** | How many times (1 when not given). | [optional] |
10
+ | **r** | **String** | Only on an &#x60;f&#x60; event: why moving the visitor on failed. &#x60;t&#x60; the composition did not appear in time, &#x60;e&#x60; the widget in it reported an error, &#x60;b&#x60; the composition could not be built, &#x60;o&#x60; another reason (a step was already on its way, or the page was going away). Left out by an embed that does not say why; a letter this server does not know is read as left out, and the failure is still counted. On an &#x60;n&#x60; or an &#x60;e&#x60; event it is ignored. Never a message: one letter, so that nothing a visitor typed can ride on it. | [optional] |
10
11
 
11
12
  ## Example
12
13
 
@@ -16,7 +17,8 @@ require 'api-sdk-rb'
16
17
  instance = ApiSdkRb::PublicWorkflowEventsRequestEventsInner.new(
17
18
  k: null,
18
19
  id: null,
19
- c: null
20
+ c: null,
21
+ r: null
20
22
  )
21
23
  ```
22
24
 
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::GetPublicWorkflow200Response
1
+ # ApiSdkRb::PublicWorkflowResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'api-sdk-rb'
15
15
 
16
- instance = ApiSdkRb::GetPublicWorkflow200Response.new(
16
+ instance = ApiSdkRb::PublicWorkflowResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
data/docs/TokensApi.md CHANGED
@@ -4,15 +4,17 @@ All URIs are relative to *https://api.widgetic.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**validate_token_0**](TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token |
7
+ | [**validate_token**](TokensApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token |
8
8
 
9
9
 
10
- ## validate_token_0
10
+ ## validate_token
11
11
 
12
- > <ValidateToken200Response> validate_token_0
12
+ > <ValidateToken200Response> validate_token
13
13
 
14
14
  Validate current authentication token
15
15
 
16
+ Describes the credential the request was made with: how it signs in (`tokenType`), what it may do (`scopes`) and the account it belongs to (`userId`). A credential that belongs to the platform itself, and not to a customer's account, is held to no scope: it is answered with `tokenType` `service_key`, `scopes` `[\"*:*\"]` and no `userId`.
17
+
16
18
  ### Examples
17
19
 
18
20
  ```ruby
@@ -33,28 +35,28 @@ api_instance = ApiSdkRb::TokensApi.new
33
35
 
34
36
  begin
35
37
  # Validate current authentication token
36
- result = api_instance.validate_token_0
38
+ result = api_instance.validate_token
37
39
  p result
38
40
  rescue ApiSdkRb::ApiError => e
39
- puts "Error when calling TokensApi->validate_token_0: #{e}"
41
+ puts "Error when calling TokensApi->validate_token: #{e}"
40
42
  end
41
43
  ```
42
44
 
43
- #### Using the validate_token_0_with_http_info variant
45
+ #### Using the validate_token_with_http_info variant
44
46
 
45
47
  This returns an Array which contains the response data, status code and headers.
46
48
 
47
- > <Array(<ValidateToken200Response>, Integer, Hash)> validate_token_0_with_http_info
49
+ > <Array(<ValidateToken200Response>, Integer, Hash)> validate_token_with_http_info
48
50
 
49
51
  ```ruby
50
52
  begin
51
53
  # Validate current authentication token
52
- data, status_code, headers = api_instance.validate_token_0_with_http_info
54
+ data, status_code, headers = api_instance.validate_token_with_http_info
53
55
  p status_code # => 2xx
54
56
  p headers # => { ... }
55
57
  p data # => <ValidateToken200Response>
56
58
  rescue ApiSdkRb::ApiError => e
57
- puts "Error when calling TokensApi->validate_token_0_with_http_info: #{e}"
59
+ puts "Error when calling TokensApi->validate_token_with_http_info: #{e}"
58
60
  end
59
61
  ```
60
62
 
data/docs/Upload.md CHANGED
@@ -16,7 +16,7 @@
16
16
  | **source** | **String** | Which part of the product, or which client, uploaded the file. &#x60;widget-visitor-upload&#x60; is a file a visitor sent through a widget&#39;s upload adapter; it cannot be asked for when uploading. | |
17
17
  | **widget_id** | **String** | | [optional] |
18
18
  | **conversation_id** | **String** | | [optional] |
19
- | **managed_user_id** | **String** | The managed user the file was uploaded for, or null when it is the account&#39;s own. List one managed user&#39;s files with the &#x60;managed_user_id&#x60; or &#x60;managed_user_external_id&#x60; query parameter of &#x60;uploadsGet&#x60;. | [optional] |
19
+ | **managed_user_id** | **String** | The managed user the file was uploaded for, or null when it is the account&#39;s own. List one managed user&#39;s files with the &#x60;managed_user_id&#x60; or &#x60;managed_user_external_id&#x60; query parameter of &#x60;listUploads&#x60;. | [optional] |
20
20
  | **purpose** | **String** | Where in the product the partner uses the file, or null when unknown | [optional] |
21
21
 
22
22
  ## Example
data/docs/UploadLimits.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **multipart_max_bytes** | **Integer** | The largest file &#x60;uploadsPost&#x60; takes in one request, in bytes. The same for every account. | [optional] |
8
- | **multipart_mime_types** | **Array&lt;String&gt;** | The file types &#x60;uploadsPost&#x60; takes for media (&#x60;content-property&#x60; uploads) | [optional] |
9
- | **tus_enabled** | **Boolean** | Whether resumable uploads are switched on. They need a signed-in session; an API key uses &#x60;uploadsPost&#x60;. | [optional] |
7
+ | **multipart_max_bytes** | **Integer** | The largest file &#x60;uploadFile&#x60; takes in one request, in bytes. The same for every account. | [optional] |
8
+ | **multipart_mime_types** | **Array&lt;String&gt;** | The file types &#x60;uploadFile&#x60; takes for media (&#x60;content-property&#x60; uploads) | [optional] |
9
+ | **tus_enabled** | **Boolean** | Whether resumable uploads are switched on. They need a signed-in session; an API key uses &#x60;uploadFile&#x60;. | [optional] |
10
10
  | **tus_max_bytes** | **Integer** | The largest file a resumable upload takes, in bytes (250 MB by default). The same for every account, whatever its plan. A file over &#x60;multipart_max_bytes&#x60; goes through a resumable upload. | [optional] |
11
11
  | **tus_chunk_size_bytes** | **Integer** | The chunk size resumable uploads are tuned for, in bytes. A client may send smaller or larger chunks. | [optional] |
12
12
  | **tus_mime_types** | **Array&lt;String&gt;** | | [optional] |