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
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::GetPartnerCreditTransactions200Response
1
+ # ApiSdkRb::AccountCreditTransactionListResponse
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::GetPartnerCreditTransactions200Response.new(
16
+ instance = ApiSdkRb::AccountCreditTransactionListResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::GetUserAdapterConnections200Response
1
+ # ApiSdkRb::AdapterConnectionListResponse
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::GetUserAdapterConnections200Response.new(
16
+ instance = ApiSdkRb::AdapterConnectionListResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::RemoveUserAdapterConnection200Response
1
+ # ApiSdkRb::AdapterConnectionRemovalResponse
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::RemoveUserAdapterConnection200Response.new(
16
+ instance = ApiSdkRb::AdapterConnectionRemovalResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::SetUserAdapterConnection200Response
1
+ # ApiSdkRb::AdapterConnectionResponse
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::SetUserAdapterConnection200Response.new(
16
+ instance = ApiSdkRb::AdapterConnectionResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
@@ -1,4 +1,4 @@
1
- # ApiSdkRb::AddAiAnswersKnowledgeDocument201Response
1
+ # ApiSdkRb::AiAnswersKnowledgeDocumentResponse
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::AddAiAnswersKnowledgeDocument201Response.new(
16
+ instance = ApiSdkRb::AiAnswersKnowledgeDocumentResponse.new(
17
17
  success: null,
18
18
  data: null,
19
19
  meta: null
data/docs/BrandKitApi.md CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *https://api.widgetic.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**delete_brand_kit_0**](BrandKitApi.md#delete_brand_kit_0) | **DELETE** /brand-kit | Reset the Brand Kit to the default |
8
- | [**delete_brand_kit_asset_0**](BrandKitApi.md#delete_brand_kit_asset_0) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit |
9
- | [**get_brand_kit_0**](BrandKitApi.md#get_brand_kit_0) | **GET** /brand-kit | The Brand Kit of the current workspace |
10
- | [**patch_brand_kit_0**](BrandKitApi.md#patch_brand_kit_0) | **PATCH** /brand-kit | Change part of the Brand Kit |
11
- | [**patch_brand_kit_asset_0**](BrandKitApi.md#patch_brand_kit_asset_0) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant |
12
- | [**post_brand_kit_font_0**](BrandKitApi.md#post_brand_kit_font_0) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit |
13
- | [**post_brand_kit_icon_0**](BrandKitApi.md#post_brand_kit_icon_0) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit |
14
- | [**put_brand_kit_0**](BrandKitApi.md#put_brand_kit_0) | **PUT** /brand-kit | Save Brand Kit tokens |
7
+ | [**delete_brand_kit**](BrandKitApi.md#delete_brand_kit) | **DELETE** /brand-kit | Reset the Brand Kit to the default |
8
+ | [**delete_brand_kit_asset**](BrandKitApi.md#delete_brand_kit_asset) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit |
9
+ | [**get_brand_kit**](BrandKitApi.md#get_brand_kit) | **GET** /brand-kit | The Brand Kit of the current workspace |
10
+ | [**patch_brand_kit**](BrandKitApi.md#patch_brand_kit) | **PATCH** /brand-kit | Change part of the Brand Kit |
11
+ | [**patch_brand_kit_asset**](BrandKitApi.md#patch_brand_kit_asset) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant |
12
+ | [**post_brand_kit_font**](BrandKitApi.md#post_brand_kit_font) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit |
13
+ | [**post_brand_kit_icon**](BrandKitApi.md#post_brand_kit_icon) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit |
14
+ | [**put_brand_kit**](BrandKitApi.md#put_brand_kit) | **PUT** /brand-kit | Save Brand Kit tokens |
15
15
 
16
16
 
17
- ## delete_brand_kit_0
17
+ ## delete_brand_kit
18
18
 
19
- > <BrandKitViewResponse> delete_brand_kit_0(opts)
19
+ > <BrandKitViewResponse> delete_brand_kit(opts)
20
20
 
21
21
  Reset the Brand Kit to the default
22
22
 
@@ -38,28 +38,28 @@ opts = {
38
38
 
39
39
  begin
40
40
  # Reset the Brand Kit to the default
41
- result = api_instance.delete_brand_kit_0(opts)
41
+ result = api_instance.delete_brand_kit(opts)
42
42
  p result
43
43
  rescue ApiSdkRb::ApiError => e
44
- puts "Error when calling BrandKitApi->delete_brand_kit_0: #{e}"
44
+ puts "Error when calling BrandKitApi->delete_brand_kit: #{e}"
45
45
  end
46
46
  ```
47
47
 
48
- #### Using the delete_brand_kit_0_with_http_info variant
48
+ #### Using the delete_brand_kit_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(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_0_with_http_info(opts)
52
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_with_http_info(opts)
53
53
 
54
54
  ```ruby
55
55
  begin
56
56
  # Reset the Brand Kit to the default
57
- data, status_code, headers = api_instance.delete_brand_kit_0_with_http_info(opts)
57
+ data, status_code, headers = api_instance.delete_brand_kit_with_http_info(opts)
58
58
  p status_code # => 2xx
59
59
  p headers # => { ... }
60
60
  p data # => <BrandKitViewResponse>
61
61
  rescue ApiSdkRb::ApiError => e
62
- puts "Error when calling BrandKitApi->delete_brand_kit_0_with_http_info: #{e}"
62
+ puts "Error when calling BrandKitApi->delete_brand_kit_with_http_info: #{e}"
63
63
  end
64
64
  ```
65
65
 
@@ -83,9 +83,9 @@ end
83
83
  - **Accept**: application/json
84
84
 
85
85
 
86
- ## delete_brand_kit_asset_0
86
+ ## delete_brand_kit_asset
87
87
 
88
- > <BrandKitViewResponse> delete_brand_kit_asset_0(asset_id, opts)
88
+ > <BrandKitViewResponse> delete_brand_kit_asset(asset_id, opts)
89
89
 
90
90
  Remove a font or icon from the Brand Kit
91
91
 
@@ -108,28 +108,28 @@ opts = {
108
108
 
109
109
  begin
110
110
  # Remove a font or icon from the Brand Kit
111
- result = api_instance.delete_brand_kit_asset_0(asset_id, opts)
111
+ result = api_instance.delete_brand_kit_asset(asset_id, opts)
112
112
  p result
113
113
  rescue ApiSdkRb::ApiError => e
114
- puts "Error when calling BrandKitApi->delete_brand_kit_asset_0: #{e}"
114
+ puts "Error when calling BrandKitApi->delete_brand_kit_asset: #{e}"
115
115
  end
116
116
  ```
117
117
 
118
- #### Using the delete_brand_kit_asset_0_with_http_info variant
118
+ #### Using the delete_brand_kit_asset_with_http_info variant
119
119
 
120
120
  This returns an Array which contains the response data, status code and headers.
121
121
 
122
- > <Array(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_asset_0_with_http_info(asset_id, opts)
122
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> delete_brand_kit_asset_with_http_info(asset_id, opts)
123
123
 
124
124
  ```ruby
125
125
  begin
126
126
  # Remove a font or icon from the Brand Kit
127
- data, status_code, headers = api_instance.delete_brand_kit_asset_0_with_http_info(asset_id, opts)
127
+ data, status_code, headers = api_instance.delete_brand_kit_asset_with_http_info(asset_id, opts)
128
128
  p status_code # => 2xx
129
129
  p headers # => { ... }
130
130
  p data # => <BrandKitViewResponse>
131
131
  rescue ApiSdkRb::ApiError => e
132
- puts "Error when calling BrandKitApi->delete_brand_kit_asset_0_with_http_info: #{e}"
132
+ puts "Error when calling BrandKitApi->delete_brand_kit_asset_with_http_info: #{e}"
133
133
  end
134
134
  ```
135
135
 
@@ -154,9 +154,9 @@ end
154
154
  - **Accept**: application/json
155
155
 
156
156
 
157
- ## get_brand_kit_0
157
+ ## get_brand_kit
158
158
 
159
- > <BrandKitViewResponse> get_brand_kit_0(opts)
159
+ > <BrandKitViewResponse> get_brand_kit(opts)
160
160
 
161
161
  The Brand Kit of the current workspace
162
162
 
@@ -180,28 +180,28 @@ opts = {
180
180
 
181
181
  begin
182
182
  # The Brand Kit of the current workspace
183
- result = api_instance.get_brand_kit_0(opts)
183
+ result = api_instance.get_brand_kit(opts)
184
184
  p result
185
185
  rescue ApiSdkRb::ApiError => e
186
- puts "Error when calling BrandKitApi->get_brand_kit_0: #{e}"
186
+ puts "Error when calling BrandKitApi->get_brand_kit: #{e}"
187
187
  end
188
188
  ```
189
189
 
190
- #### Using the get_brand_kit_0_with_http_info variant
190
+ #### Using the get_brand_kit_with_http_info variant
191
191
 
192
192
  This returns an Array which contains the response data, status code and headers.
193
193
 
194
- > <Array(<BrandKitViewResponse>, Integer, Hash)> get_brand_kit_0_with_http_info(opts)
194
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> get_brand_kit_with_http_info(opts)
195
195
 
196
196
  ```ruby
197
197
  begin
198
198
  # The Brand Kit of the current workspace
199
- data, status_code, headers = api_instance.get_brand_kit_0_with_http_info(opts)
199
+ data, status_code, headers = api_instance.get_brand_kit_with_http_info(opts)
200
200
  p status_code # => 2xx
201
201
  p headers # => { ... }
202
202
  p data # => <BrandKitViewResponse>
203
203
  rescue ApiSdkRb::ApiError => e
204
- puts "Error when calling BrandKitApi->get_brand_kit_0_with_http_info: #{e}"
204
+ puts "Error when calling BrandKitApi->get_brand_kit_with_http_info: #{e}"
205
205
  end
206
206
  ```
207
207
 
@@ -225,13 +225,13 @@ end
225
225
  - **Accept**: application/json
226
226
 
227
227
 
228
- ## patch_brand_kit_0
228
+ ## patch_brand_kit
229
229
 
230
- > <BrandKitViewResponse> patch_brand_kit_0(patch_brand_kit_request, opts)
230
+ > <BrandKitViewResponse> patch_brand_kit(patch_brand_kit_request, opts)
231
231
 
232
232
  Change part of the Brand Kit
233
233
 
234
- Changes only what is sent: the colors, a font role, a spacing step, one corner radius (0 for square corners) or the style notes, and keeps the rest of the saved kit. An account that never saved a kit starts from Widgetic's default one. The response lists what is worth fixing in `warnings`.
234
+ Changes only what is sent: the colors, a font role, the text styles, a spacing step, one corner radius (0 for square corners) or the style notes, and keeps the rest of the saved kit, text styles included. An account that never saved a kit starts from Widgetic's default one. The response lists what is worth fixing in `warnings`.
235
235
 
236
236
  ### Examples
237
237
 
@@ -252,28 +252,28 @@ opts = {
252
252
 
253
253
  begin
254
254
  # Change part of the Brand Kit
255
- result = api_instance.patch_brand_kit_0(patch_brand_kit_request, opts)
255
+ result = api_instance.patch_brand_kit(patch_brand_kit_request, opts)
256
256
  p result
257
257
  rescue ApiSdkRb::ApiError => e
258
- puts "Error when calling BrandKitApi->patch_brand_kit_0: #{e}"
258
+ puts "Error when calling BrandKitApi->patch_brand_kit: #{e}"
259
259
  end
260
260
  ```
261
261
 
262
- #### Using the patch_brand_kit_0_with_http_info variant
262
+ #### Using the patch_brand_kit_with_http_info variant
263
263
 
264
264
  This returns an Array which contains the response data, status code and headers.
265
265
 
266
- > <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_0_with_http_info(patch_brand_kit_request, opts)
266
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_with_http_info(patch_brand_kit_request, opts)
267
267
 
268
268
  ```ruby
269
269
  begin
270
270
  # Change part of the Brand Kit
271
- data, status_code, headers = api_instance.patch_brand_kit_0_with_http_info(patch_brand_kit_request, opts)
271
+ data, status_code, headers = api_instance.patch_brand_kit_with_http_info(patch_brand_kit_request, opts)
272
272
  p status_code # => 2xx
273
273
  p headers # => { ... }
274
274
  p data # => <BrandKitViewResponse>
275
275
  rescue ApiSdkRb::ApiError => e
276
- puts "Error when calling BrandKitApi->patch_brand_kit_0_with_http_info: #{e}"
276
+ puts "Error when calling BrandKitApi->patch_brand_kit_with_http_info: #{e}"
277
277
  end
278
278
  ```
279
279
 
@@ -298,9 +298,9 @@ end
298
298
  - **Accept**: application/json
299
299
 
300
300
 
301
- ## patch_brand_kit_asset_0
301
+ ## patch_brand_kit_asset
302
302
 
303
- > <BrandKitViewResponse> patch_brand_kit_asset_0(asset_id, patch_brand_kit_asset_request, opts)
303
+ > <BrandKitViewResponse> patch_brand_kit_asset(asset_id, patch_brand_kit_asset_request, opts)
304
304
 
305
305
  Rename an icon or relabel a font variant
306
306
 
@@ -324,28 +324,28 @@ opts = {
324
324
 
325
325
  begin
326
326
  # Rename an icon or relabel a font variant
327
- result = api_instance.patch_brand_kit_asset_0(asset_id, patch_brand_kit_asset_request, opts)
327
+ result = api_instance.patch_brand_kit_asset(asset_id, patch_brand_kit_asset_request, opts)
328
328
  p result
329
329
  rescue ApiSdkRb::ApiError => e
330
- puts "Error when calling BrandKitApi->patch_brand_kit_asset_0: #{e}"
330
+ puts "Error when calling BrandKitApi->patch_brand_kit_asset: #{e}"
331
331
  end
332
332
  ```
333
333
 
334
- #### Using the patch_brand_kit_asset_0_with_http_info variant
334
+ #### Using the patch_brand_kit_asset_with_http_info variant
335
335
 
336
336
  This returns an Array which contains the response data, status code and headers.
337
337
 
338
- > <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_asset_0_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
338
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> patch_brand_kit_asset_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
339
339
 
340
340
  ```ruby
341
341
  begin
342
342
  # Rename an icon or relabel a font variant
343
- data, status_code, headers = api_instance.patch_brand_kit_asset_0_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
343
+ data, status_code, headers = api_instance.patch_brand_kit_asset_with_http_info(asset_id, patch_brand_kit_asset_request, opts)
344
344
  p status_code # => 2xx
345
345
  p headers # => { ... }
346
346
  p data # => <BrandKitViewResponse>
347
347
  rescue ApiSdkRb::ApiError => e
348
- puts "Error when calling BrandKitApi->patch_brand_kit_asset_0_with_http_info: #{e}"
348
+ puts "Error when calling BrandKitApi->patch_brand_kit_asset_with_http_info: #{e}"
349
349
  end
350
350
  ```
351
351
 
@@ -371,9 +371,9 @@ end
371
371
  - **Accept**: application/json
372
372
 
373
373
 
374
- ## post_brand_kit_font_0
374
+ ## post_brand_kit_font
375
375
 
376
- > <BrandKitViewResponse> post_brand_kit_font_0(file, family, weight, opts)
376
+ > <BrandKitViewResponse> post_brand_kit_font(file, family, weight, opts)
377
377
 
378
378
  Upload a font file to the Brand Kit
379
379
 
@@ -399,28 +399,28 @@ opts = {
399
399
 
400
400
  begin
401
401
  # Upload a font file to the Brand Kit
402
- result = api_instance.post_brand_kit_font_0(file, family, weight, opts)
402
+ result = api_instance.post_brand_kit_font(file, family, weight, opts)
403
403
  p result
404
404
  rescue ApiSdkRb::ApiError => e
405
- puts "Error when calling BrandKitApi->post_brand_kit_font_0: #{e}"
405
+ puts "Error when calling BrandKitApi->post_brand_kit_font: #{e}"
406
406
  end
407
407
  ```
408
408
 
409
- #### Using the post_brand_kit_font_0_with_http_info variant
409
+ #### Using the post_brand_kit_font_with_http_info variant
410
410
 
411
411
  This returns an Array which contains the response data, status code and headers.
412
412
 
413
- > <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_font_0_with_http_info(file, family, weight, opts)
413
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_font_with_http_info(file, family, weight, opts)
414
414
 
415
415
  ```ruby
416
416
  begin
417
417
  # Upload a font file to the Brand Kit
418
- data, status_code, headers = api_instance.post_brand_kit_font_0_with_http_info(file, family, weight, opts)
418
+ data, status_code, headers = api_instance.post_brand_kit_font_with_http_info(file, family, weight, opts)
419
419
  p status_code # => 2xx
420
420
  p headers # => { ... }
421
421
  p data # => <BrandKitViewResponse>
422
422
  rescue ApiSdkRb::ApiError => e
423
- puts "Error when calling BrandKitApi->post_brand_kit_font_0_with_http_info: #{e}"
423
+ puts "Error when calling BrandKitApi->post_brand_kit_font_with_http_info: #{e}"
424
424
  end
425
425
  ```
426
426
 
@@ -448,9 +448,9 @@ end
448
448
  - **Accept**: application/json
449
449
 
450
450
 
451
- ## post_brand_kit_icon_0
451
+ ## post_brand_kit_icon
452
452
 
453
- > <BrandKitViewResponse> post_brand_kit_icon_0(post_brand_kit_icon_request, opts)
453
+ > <BrandKitViewResponse> post_brand_kit_icon(post_brand_kit_icon_request, opts)
454
454
 
455
455
  Add a named SVG icon to the Brand Kit
456
456
 
@@ -473,28 +473,28 @@ opts = {
473
473
 
474
474
  begin
475
475
  # Add a named SVG icon to the Brand Kit
476
- result = api_instance.post_brand_kit_icon_0(post_brand_kit_icon_request, opts)
476
+ result = api_instance.post_brand_kit_icon(post_brand_kit_icon_request, opts)
477
477
  p result
478
478
  rescue ApiSdkRb::ApiError => e
479
- puts "Error when calling BrandKitApi->post_brand_kit_icon_0: #{e}"
479
+ puts "Error when calling BrandKitApi->post_brand_kit_icon: #{e}"
480
480
  end
481
481
  ```
482
482
 
483
- #### Using the post_brand_kit_icon_0_with_http_info variant
483
+ #### Using the post_brand_kit_icon_with_http_info variant
484
484
 
485
485
  This returns an Array which contains the response data, status code and headers.
486
486
 
487
- > <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_icon_0_with_http_info(post_brand_kit_icon_request, opts)
487
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> post_brand_kit_icon_with_http_info(post_brand_kit_icon_request, opts)
488
488
 
489
489
  ```ruby
490
490
  begin
491
491
  # Add a named SVG icon to the Brand Kit
492
- data, status_code, headers = api_instance.post_brand_kit_icon_0_with_http_info(post_brand_kit_icon_request, opts)
492
+ data, status_code, headers = api_instance.post_brand_kit_icon_with_http_info(post_brand_kit_icon_request, opts)
493
493
  p status_code # => 2xx
494
494
  p headers # => { ... }
495
495
  p data # => <BrandKitViewResponse>
496
496
  rescue ApiSdkRb::ApiError => e
497
- puts "Error when calling BrandKitApi->post_brand_kit_icon_0_with_http_info: #{e}"
497
+ puts "Error when calling BrandKitApi->post_brand_kit_icon_with_http_info: #{e}"
498
498
  end
499
499
  ```
500
500
 
@@ -519,13 +519,13 @@ end
519
519
  - **Accept**: application/json
520
520
 
521
521
 
522
- ## put_brand_kit_0
522
+ ## put_brand_kit
523
523
 
524
- > <BrandKitViewResponse> put_brand_kit_0(put_brand_kit_request, opts)
524
+ > <BrandKitViewResponse> put_brand_kit(put_brand_kit_request, opts)
525
525
 
526
526
  Save Brand Kit tokens
527
527
 
528
- Replaces the colors, fonts, spacing and notes of the kit with the ones sent. To change one thing, use PATCH.
528
+ Replaces the colors, fonts, text styles, spacing and notes of the kit with the ones sent, so text styles left out of the body are removed. To change one thing, use PATCH.
529
529
 
530
530
  ### Examples
531
531
 
@@ -546,28 +546,28 @@ opts = {
546
546
 
547
547
  begin
548
548
  # Save Brand Kit tokens
549
- result = api_instance.put_brand_kit_0(put_brand_kit_request, opts)
549
+ result = api_instance.put_brand_kit(put_brand_kit_request, opts)
550
550
  p result
551
551
  rescue ApiSdkRb::ApiError => e
552
- puts "Error when calling BrandKitApi->put_brand_kit_0: #{e}"
552
+ puts "Error when calling BrandKitApi->put_brand_kit: #{e}"
553
553
  end
554
554
  ```
555
555
 
556
- #### Using the put_brand_kit_0_with_http_info variant
556
+ #### Using the put_brand_kit_with_http_info variant
557
557
 
558
558
  This returns an Array which contains the response data, status code and headers.
559
559
 
560
- > <Array(<BrandKitViewResponse>, Integer, Hash)> put_brand_kit_0_with_http_info(put_brand_kit_request, opts)
560
+ > <Array(<BrandKitViewResponse>, Integer, Hash)> put_brand_kit_with_http_info(put_brand_kit_request, opts)
561
561
 
562
562
  ```ruby
563
563
  begin
564
564
  # Save Brand Kit tokens
565
- data, status_code, headers = api_instance.put_brand_kit_0_with_http_info(put_brand_kit_request, opts)
565
+ data, status_code, headers = api_instance.put_brand_kit_with_http_info(put_brand_kit_request, opts)
566
566
  p status_code # => 2xx
567
567
  p headers # => { ... }
568
568
  p data # => <BrandKitViewResponse>
569
569
  rescue ApiSdkRb::ApiError => e
570
- puts "Error when calling BrandKitApi->put_brand_kit_0_with_http_info: #{e}"
570
+ puts "Error when calling BrandKitApi->put_brand_kit_with_http_info: #{e}"
571
571
  end
572
572
  ```
573
573
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **colors** | [**Array&lt;BrandColor&gt;**](BrandColor.md) | | |
8
8
  | **fonts** | [**BrandKitTokensFonts**](BrandKitTokensFonts.md) | | |
9
+ | **text_styles** | [**Array&lt;BrandTextStyle&gt;**](BrandTextStyle.md) | The owner&#39;s text styles (family, weight and size). When there are some, they are what every widget made with the kit is told about type and the fonts by role are not used; with none, the fonts by role apply. A font file that is deleted takes the text styles made from it with it. Left out when the kit has none. | [optional] |
9
10
  | **spacing** | [**BrandSpacing**](BrandSpacing.md) | | |
10
11
  | **instructions** | **String** | The kit owner&#39;s own style notes, taken into account in every widget made with the kit, for example \&quot;Use the dark color as the background always and the light color for titles\&quot;. They are about how a widget looks and never about what it holds, and what a request names itself wins over them. Left out, Widgetic&#39;s default note applies (\&quot;Widget backgrounds to be white whenever possible.\&quot;); an empty string means none. | [optional] |
11
12
 
@@ -17,6 +18,7 @@ require 'api-sdk-rb'
17
18
  instance = ApiSdkRb::BrandKitTokens.new(
18
19
  colors: null,
19
20
  fonts: null,
21
+ text_styles: null,
20
22
  spacing: null,
21
23
  instructions: null
22
24
  )
data/docs/BrandKitView.md CHANGED
@@ -13,7 +13,7 @@
13
13
  | **figma_source** | [**BrandKitFigmaSource**](BrandKitFigmaSource.md) | | [optional] |
14
14
  | **updated_at** | **Time** | | [optional] |
15
15
  | **updated_by** | **String** | | [optional] |
16
- | **warnings** | **Array&lt;String&gt;** | Things worth fixing in the saved colors, such as a text color that is hard to read on the background. The kit is saved either way. | [optional] |
16
+ | **warnings** | **Array&lt;String&gt;** | Things worth fixing in the saved kit, such as a text color that is hard to read on the background, or fonts by role that are not used because the kit has text styles. The kit is saved either way. | [optional] |
17
17
 
18
18
  ## Example
19
19
 
@@ -0,0 +1,22 @@
1
+ # ApiSdkRb::BrandTextStyle
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **family** | **String** | | |
8
+ | **weight** | **Integer** | | |
9
+ | **size** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'api-sdk-rb'
15
+
16
+ instance = ApiSdkRb::BrandTextStyle.new(
17
+ family: null,
18
+ weight: null,
19
+ size: null
20
+ )
21
+ ```
22
+