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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::ContentItemWriteResultResponse
|
|
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::
|
|
16
|
+
instance = ApiSdkRb::ContentItemWriteResultResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
data/docs/CreditsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
7
|
+
| [**get_user_credit_balance**](CreditsApi.md#get_user_credit_balance) | **GET** /credits/user/{userId}/balance | Get an account's credit balance |
|
|
8
|
+
| [**get_user_credit_transactions**](CreditsApi.md#get_user_credit_transactions) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger |
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## get_user_credit_balance
|
|
12
12
|
|
|
13
|
-
> <AccountCreditBalanceResponse>
|
|
13
|
+
> <AccountCreditBalanceResponse> get_user_credit_balance(user_id)
|
|
14
14
|
|
|
15
15
|
Get an account's credit balance
|
|
16
16
|
|
|
@@ -32,28 +32,28 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account whose ba
|
|
|
32
32
|
|
|
33
33
|
begin
|
|
34
34
|
# Get an account's credit balance
|
|
35
|
-
result = api_instance.
|
|
35
|
+
result = api_instance.get_user_credit_balance(user_id)
|
|
36
36
|
p result
|
|
37
37
|
rescue ApiSdkRb::ApiError => e
|
|
38
|
-
puts "Error when calling CreditsApi->
|
|
38
|
+
puts "Error when calling CreditsApi->get_user_credit_balance: #{e}"
|
|
39
39
|
end
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
#### Using the
|
|
42
|
+
#### Using the get_user_credit_balance_with_http_info variant
|
|
43
43
|
|
|
44
44
|
This returns an Array which contains the response data, status code and headers.
|
|
45
45
|
|
|
46
|
-
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)>
|
|
46
|
+
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)> get_user_credit_balance_with_http_info(user_id)
|
|
47
47
|
|
|
48
48
|
```ruby
|
|
49
49
|
begin
|
|
50
50
|
# Get an account's credit balance
|
|
51
|
-
data, status_code, headers = api_instance.
|
|
51
|
+
data, status_code, headers = api_instance.get_user_credit_balance_with_http_info(user_id)
|
|
52
52
|
p status_code # => 2xx
|
|
53
53
|
p headers # => { ... }
|
|
54
54
|
p data # => <AccountCreditBalanceResponse>
|
|
55
55
|
rescue ApiSdkRb::ApiError => e
|
|
56
|
-
puts "Error when calling CreditsApi->
|
|
56
|
+
puts "Error when calling CreditsApi->get_user_credit_balance_with_http_info: #{e}"
|
|
57
57
|
end
|
|
58
58
|
```
|
|
59
59
|
|
|
@@ -77,9 +77,9 @@ end
|
|
|
77
77
|
- **Accept**: application/json
|
|
78
78
|
|
|
79
79
|
|
|
80
|
-
##
|
|
80
|
+
## get_user_credit_transactions
|
|
81
81
|
|
|
82
|
-
> <
|
|
82
|
+
> <AccountCreditTransactionListResponse> get_user_credit_transactions(user_id, opts)
|
|
83
83
|
|
|
84
84
|
List an account's credit ledger
|
|
85
85
|
|
|
@@ -106,28 +106,28 @@ opts = {
|
|
|
106
106
|
|
|
107
107
|
begin
|
|
108
108
|
# List an account's credit ledger
|
|
109
|
-
result = api_instance.
|
|
109
|
+
result = api_instance.get_user_credit_transactions(user_id, opts)
|
|
110
110
|
p result
|
|
111
111
|
rescue ApiSdkRb::ApiError => e
|
|
112
|
-
puts "Error when calling CreditsApi->
|
|
112
|
+
puts "Error when calling CreditsApi->get_user_credit_transactions: #{e}"
|
|
113
113
|
end
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
#### Using the
|
|
116
|
+
#### Using the get_user_credit_transactions_with_http_info variant
|
|
117
117
|
|
|
118
118
|
This returns an Array which contains the response data, status code and headers.
|
|
119
119
|
|
|
120
|
-
> <Array(<
|
|
120
|
+
> <Array(<AccountCreditTransactionListResponse>, Integer, Hash)> get_user_credit_transactions_with_http_info(user_id, opts)
|
|
121
121
|
|
|
122
122
|
```ruby
|
|
123
123
|
begin
|
|
124
124
|
# List an account's credit ledger
|
|
125
|
-
data, status_code, headers = api_instance.
|
|
125
|
+
data, status_code, headers = api_instance.get_user_credit_transactions_with_http_info(user_id, opts)
|
|
126
126
|
p status_code # => 2xx
|
|
127
127
|
p headers # => { ... }
|
|
128
|
-
p data # => <
|
|
128
|
+
p data # => <AccountCreditTransactionListResponse>
|
|
129
129
|
rescue ApiSdkRb::ApiError => e
|
|
130
|
-
puts "Error when calling CreditsApi->
|
|
130
|
+
puts "Error when calling CreditsApi->get_user_credit_transactions_with_http_info: #{e}"
|
|
131
131
|
end
|
|
132
132
|
```
|
|
133
133
|
|
|
@@ -142,7 +142,7 @@ end
|
|
|
142
142
|
|
|
143
143
|
### Return type
|
|
144
144
|
|
|
145
|
-
[**
|
|
145
|
+
[**AccountCreditTransactionListResponse**](AccountCreditTransactionListResponse.md)
|
|
146
146
|
|
|
147
147
|
### Authorization
|
|
148
148
|
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::DeleteUpload200Response
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **success** | **Boolean** | | |
|
|
8
|
-
| **data** | [**
|
|
8
|
+
| **data** | [**DeleteUpload200ResponseData**](DeleteUpload200ResponseData.md) | | |
|
|
9
9
|
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'api-sdk-rb'
|
|
15
15
|
|
|
16
|
-
instance = ApiSdkRb::
|
|
16
|
+
instance = ApiSdkRb::DeleteUpload200Response.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::DeleteUpload200ResponseData
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'api-sdk-rb'
|
|
13
13
|
|
|
14
|
-
instance = ApiSdkRb::
|
|
14
|
+
instance = ApiSdkRb::DeleteUpload200ResponseData.new(
|
|
15
15
|
deleted: null
|
|
16
16
|
)
|
|
17
17
|
```
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::DesignDefaultsResponse
|
|
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::
|
|
16
|
+
instance = ApiSdkRb::DesignDefaultsResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
data/docs/EntitlementsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
7
|
+
| [**get_managed_user_entitlements**](EntitlementsApi.md#get_managed_user_entitlements) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements |
|
|
8
|
+
| [**get_partner_entitlements**](EntitlementsApi.md#get_partner_entitlements) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements |
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## get_managed_user_entitlements
|
|
12
12
|
|
|
13
|
-
> <GetManagedUserEntitlementsResponse>
|
|
13
|
+
> <GetManagedUserEntitlementsResponse> get_managed_user_entitlements(managed_user_id, opts)
|
|
14
14
|
|
|
15
15
|
Get managed user entitlements
|
|
16
16
|
|
|
@@ -37,28 +37,28 @@ opts = {
|
|
|
37
37
|
|
|
38
38
|
begin
|
|
39
39
|
# Get managed user entitlements
|
|
40
|
-
result = api_instance.
|
|
40
|
+
result = api_instance.get_managed_user_entitlements(managed_user_id, opts)
|
|
41
41
|
p result
|
|
42
42
|
rescue ApiSdkRb::ApiError => e
|
|
43
|
-
puts "Error when calling EntitlementsApi->
|
|
43
|
+
puts "Error when calling EntitlementsApi->get_managed_user_entitlements: #{e}"
|
|
44
44
|
end
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
#### Using the
|
|
47
|
+
#### Using the get_managed_user_entitlements_with_http_info variant
|
|
48
48
|
|
|
49
49
|
This returns an Array which contains the response data, status code and headers.
|
|
50
50
|
|
|
51
|
-
> <Array(<GetManagedUserEntitlementsResponse>, Integer, Hash)>
|
|
51
|
+
> <Array(<GetManagedUserEntitlementsResponse>, Integer, Hash)> get_managed_user_entitlements_with_http_info(managed_user_id, opts)
|
|
52
52
|
|
|
53
53
|
```ruby
|
|
54
54
|
begin
|
|
55
55
|
# Get managed user entitlements
|
|
56
|
-
data, status_code, headers = api_instance.
|
|
56
|
+
data, status_code, headers = api_instance.get_managed_user_entitlements_with_http_info(managed_user_id, opts)
|
|
57
57
|
p status_code # => 2xx
|
|
58
58
|
p headers # => { ... }
|
|
59
59
|
p data # => <GetManagedUserEntitlementsResponse>
|
|
60
60
|
rescue ApiSdkRb::ApiError => e
|
|
61
|
-
puts "Error when calling EntitlementsApi->
|
|
61
|
+
puts "Error when calling EntitlementsApi->get_managed_user_entitlements_with_http_info: #{e}"
|
|
62
62
|
end
|
|
63
63
|
```
|
|
64
64
|
|
|
@@ -85,9 +85,9 @@ end
|
|
|
85
85
|
- **Accept**: application/json
|
|
86
86
|
|
|
87
87
|
|
|
88
|
-
##
|
|
88
|
+
## get_partner_entitlements
|
|
89
89
|
|
|
90
|
-
> <GetPartnerEntitlementsResponse>
|
|
90
|
+
> <GetPartnerEntitlementsResponse> get_partner_entitlements(partner_id, opts)
|
|
91
91
|
|
|
92
92
|
Get partner entitlements
|
|
93
93
|
|
|
@@ -114,28 +114,28 @@ opts = {
|
|
|
114
114
|
|
|
115
115
|
begin
|
|
116
116
|
# Get partner entitlements
|
|
117
|
-
result = api_instance.
|
|
117
|
+
result = api_instance.get_partner_entitlements(partner_id, opts)
|
|
118
118
|
p result
|
|
119
119
|
rescue ApiSdkRb::ApiError => e
|
|
120
|
-
puts "Error when calling EntitlementsApi->
|
|
120
|
+
puts "Error when calling EntitlementsApi->get_partner_entitlements: #{e}"
|
|
121
121
|
end
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
#### Using the
|
|
124
|
+
#### Using the get_partner_entitlements_with_http_info variant
|
|
125
125
|
|
|
126
126
|
This returns an Array which contains the response data, status code and headers.
|
|
127
127
|
|
|
128
|
-
> <Array(<GetPartnerEntitlementsResponse>, Integer, Hash)>
|
|
128
|
+
> <Array(<GetPartnerEntitlementsResponse>, Integer, Hash)> get_partner_entitlements_with_http_info(partner_id, opts)
|
|
129
129
|
|
|
130
130
|
```ruby
|
|
131
131
|
begin
|
|
132
132
|
# Get partner entitlements
|
|
133
|
-
data, status_code, headers = api_instance.
|
|
133
|
+
data, status_code, headers = api_instance.get_partner_entitlements_with_http_info(partner_id, opts)
|
|
134
134
|
p status_code # => 2xx
|
|
135
135
|
p headers # => { ... }
|
|
136
136
|
p data # => <GetPartnerEntitlementsResponse>
|
|
137
137
|
rescue ApiSdkRb::ApiError => e
|
|
138
|
-
puts "Error when calling EntitlementsApi->
|
|
138
|
+
puts "Error when calling EntitlementsApi->get_partner_entitlements_with_http_info: #{e}"
|
|
139
139
|
end
|
|
140
140
|
```
|
|
141
141
|
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::GetOperationResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **success** | **Boolean** | Always `true` on a success. | |
|
|
8
|
-
| **data** | [**
|
|
8
|
+
| **data** | [**GetOperationResponseData**](GetOperationResponseData.md) | | |
|
|
9
9
|
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'api-sdk-rb'
|
|
15
15
|
|
|
16
|
-
instance = ApiSdkRb::
|
|
16
|
+
instance = ApiSdkRb::GetOperationResponse.new(
|
|
17
17
|
success: true,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::GetOperationResponseData
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **type** | **String** | What the operation does | [optional] |
|
|
9
9
|
| **status** | **String** | Where the operation stands. `completed`, `failed` and `cancelled` are final | [optional] |
|
|
10
10
|
| **progress** | **Integer** | How far the operation has got, in percent | [optional] |
|
|
11
|
-
| **metadata** | **
|
|
11
|
+
| **metadata** | [**GetOperationResponseDataMetadata**](GetOperationResponseDataMetadata.md) | | [optional] |
|
|
12
12
|
| **error** | **String** | Why a `failed` operation failed (absent otherwise) | [optional] |
|
|
13
13
|
| **created_at** | **Time** | | [optional] |
|
|
14
14
|
| **updated_at** | **Time** | | [optional] |
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'api-sdk-rb'
|
|
20
20
|
|
|
21
|
-
instance = ApiSdkRb::
|
|
21
|
+
instance = ApiSdkRb::GetOperationResponseData.new(
|
|
22
22
|
id: null,
|
|
23
23
|
type: null,
|
|
24
24
|
status: null,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::GetOperationResponseDataMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan** | [**WidgetPlan**](WidgetPlan.md) | The plan of a code generation, published when it is made and again each time a step changes (`pending`, `in_progress`, `done`, `failed`). `null` when the build was called off, so the client hides the plan it showed. | [optional] |
|
|
8
|
+
| **outcome** | **String** | `needs_answers` on a code generation that completed by asking questions: nothing was built, the credit was returned, and the card is in `clarification`. Absent on every other outcome. | [optional] |
|
|
9
|
+
| **clarification** | [**WidgetClarification**](WidgetClarification.md) | The card of questions, present with `outcome` `needs_answers`. | [optional] |
|
|
10
|
+
| **next_steps** | [**Array<WidgetNextStep>**](WidgetNextStep.md) | Suggested next improvements of a completed code generation, the recommended one first. Absent when none were made in time or the build was not kept. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::GetOperationResponseDataMetadata.new(
|
|
18
|
+
plan: null,
|
|
19
|
+
outcome: null,
|
|
20
|
+
clarification: null,
|
|
21
|
+
next_steps: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/InvoicesApi.md
CHANGED
|
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
7
|
+
| [**get_invoices_by_partner_id**](InvoicesApi.md#get_invoices_by_partner_id) | **GET** /invoices/partner/{partnerId} | List a partner's invoices |
|
|
8
8
|
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## get_invoices_by_partner_id
|
|
11
11
|
|
|
12
|
-
> <GetInvoicesByPartnerId200Response>
|
|
12
|
+
> <GetInvoicesByPartnerId200Response> get_invoices_by_partner_id(partner_id, opts)
|
|
13
13
|
|
|
14
14
|
List a partner's invoices
|
|
15
15
|
|
|
@@ -36,28 +36,28 @@ opts = {
|
|
|
36
36
|
|
|
37
37
|
begin
|
|
38
38
|
# List a partner's invoices
|
|
39
|
-
result = api_instance.
|
|
39
|
+
result = api_instance.get_invoices_by_partner_id(partner_id, opts)
|
|
40
40
|
p result
|
|
41
41
|
rescue ApiSdkRb::ApiError => e
|
|
42
|
-
puts "Error when calling InvoicesApi->
|
|
42
|
+
puts "Error when calling InvoicesApi->get_invoices_by_partner_id: #{e}"
|
|
43
43
|
end
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
#### Using the
|
|
46
|
+
#### Using the get_invoices_by_partner_id_with_http_info variant
|
|
47
47
|
|
|
48
48
|
This returns an Array which contains the response data, status code and headers.
|
|
49
49
|
|
|
50
|
-
> <Array(<GetInvoicesByPartnerId200Response>, Integer, Hash)>
|
|
50
|
+
> <Array(<GetInvoicesByPartnerId200Response>, Integer, Hash)> get_invoices_by_partner_id_with_http_info(partner_id, opts)
|
|
51
51
|
|
|
52
52
|
```ruby
|
|
53
53
|
begin
|
|
54
54
|
# List a partner's invoices
|
|
55
|
-
data, status_code, headers = api_instance.
|
|
55
|
+
data, status_code, headers = api_instance.get_invoices_by_partner_id_with_http_info(partner_id, opts)
|
|
56
56
|
p status_code # => 2xx
|
|
57
57
|
p headers # => { ... }
|
|
58
58
|
p data # => <GetInvoicesByPartnerId200Response>
|
|
59
59
|
rescue ApiSdkRb::ApiError => e
|
|
60
|
-
puts "Error when calling InvoicesApi->
|
|
60
|
+
puts "Error when calling InvoicesApi->get_invoices_by_partner_id_with_http_info: #{e}"
|
|
61
61
|
end
|
|
62
62
|
```
|
|
63
63
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::ListUploads200Response
|
|
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::
|
|
16
|
+
instance = ApiSdkRb::ListUploads200Response.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::ManagedUserLimitsResponse
|
|
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::
|
|
16
|
+
instance = ApiSdkRb::ManagedUserLimitsResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::ManagedUserRemovalResponse
|
|
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::
|
|
16
|
+
instance = ApiSdkRb::ManagedUserRemovalResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|