weft-sdk 0.24.0 → 0.32.2
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/docs/FetchApi.md +3 -3
- data/docs/FetchErrorResponse.md +1 -1
- data/docs/FetchRequest.md +6 -2
- data/docs/FetchResponse.md +4 -4
- data/docs/GetPurchaseIdParameter.md +48 -0
- data/docs/PaymentsApi.md +2 -0
- data/docs/Purchase.md +6 -0
- data/docs/PurchasesApi.md +2 -2
- data/docs/SearchApi.md +1 -68
- data/docs/SearchCompactAccess.md +23 -0
- data/docs/SearchCompactAccessPrice.md +23 -0
- data/docs/SearchCompactNextCall.md +23 -0
- data/docs/SearchCompactResult.md +47 -0
- data/docs/SearchCompactResultAttribution.md +21 -0
- data/docs/SearchCompactResultBlockedScopesInner.md +19 -0
- data/docs/SearchCompactResultOperation.md +21 -0
- data/docs/SearchCompactResultProvider.md +19 -0
- data/docs/SearchEndpointCall.md +1 -1
- data/docs/SearchEndpointCallInputSchema.md +14 -0
- data/docs/SearchEndpointHit.md +5 -1
- data/docs/SearchHelperDocs.md +23 -0
- data/docs/SearchRequest.md +3 -1
- data/docs/SearchResponse.md +9 -3
- data/docs/SearchWeftFetchCompatibility.md +3 -1
- data/docs/WebhooksApi.md +414 -0
- data/lib/weft/client.rb +271 -0
- data/lib/weft/error.rb +41 -0
- data/lib/weft/facilitator/client.rb +179 -42
- data/lib/weft/facilitator/echo.rb +99 -0
- data/lib/weft/facilitator/extensions.rb +183 -0
- data/lib/weft/facilitator/fee.rb +26 -11
- data/lib/weft/facilitator/handshake.rb +92 -0
- data/lib/weft/facilitator/json_wire.rb +74 -0
- data/lib/weft/facilitator/middleware.rb +562 -137
- data/lib/weft/facilitator/path_match.rb +179 -0
- data/lib/weft/facilitator/product.rb +380 -0
- data/lib/weft/facilitator/replay.rb +46 -0
- data/lib/weft/facilitator/settlement.rb +117 -0
- data/lib/weft/facilitator/x402.rb +355 -0
- data/lib/weft/generated/api/account_api.rb +2 -2
- data/lib/weft/generated/api/agent_bootstrap_api.rb +2 -2
- data/lib/weft/generated/api/api_keys_api.rb +2 -2
- data/lib/weft/generated/api/auth_api.rb +2 -2
- data/lib/weft/generated/api/balance_api.rb +2 -2
- data/lib/weft/generated/api/documentation_api.rb +2 -2
- data/lib/weft/generated/api/fetch_api.rb +6 -6
- data/lib/weft/generated/api/payments_api.rb +4 -2
- data/lib/weft/generated/api/purchases_api.rb +4 -4
- data/lib/weft/generated/api/resources_api.rb +2 -2
- data/lib/weft/generated/api/search_api.rb +4 -83
- data/lib/weft/generated/api/webhooks_api.rb +388 -0
- data/lib/weft/generated/api_client.rb +2 -2
- data/lib/weft/generated/api_error.rb +2 -2
- data/lib/weft/generated/api_model_base.rb +2 -2
- data/lib/weft/generated/configuration.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_approval.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_created.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_created_approval.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_created_response.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_request.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_status.rb +2 -2
- data/lib/weft/generated/models/account_bootstrap_status_response.rb +2 -2
- data/lib/weft/generated/models/account_details.rb +2 -2
- data/lib/weft/generated/models/api_key.rb +2 -2
- data/lib/weft/generated/models/api_key_created.rb +2 -2
- data/lib/weft/generated/models/api_key_created_response.rb +2 -2
- data/lib/weft/generated/models/api_key_list_response.rb +2 -2
- data/lib/weft/generated/models/auth_response.rb +2 -2
- data/lib/weft/generated/models/auth_response_data.rb +2 -2
- data/lib/weft/generated/models/balance_response.rb +2 -2
- data/lib/weft/generated/models/confirm_request.rb +2 -2
- data/lib/weft/generated/models/create_api_key_request.rb +2 -2
- data/lib/weft/generated/models/enrolled_resource.rb +2 -2
- data/lib/weft/generated/models/error.rb +2 -2
- data/lib/weft/generated/models/error_response.rb +2 -2
- data/lib/weft/generated/models/fetch403_response.rb +2 -2
- data/lib/weft/generated/models/fetch_balance_snapshot.rb +2 -2
- data/lib/weft/generated/models/fetch_error_response.rb +5 -5
- data/lib/weft/generated/models/fetch_request.rb +46 -5
- data/lib/weft/generated/models/fetch_request_body.rb +2 -2
- data/lib/weft/generated/models/fetch_response.rb +30 -85
- data/lib/weft/generated/models/get_purchase_id_parameter.rb +104 -0
- data/lib/weft/generated/models/insufficient_scope_response.rb +2 -2
- data/lib/weft/generated/models/me_api_key.rb +2 -2
- data/lib/weft/generated/models/me_api_key_creator.rb +2 -2
- data/lib/weft/generated/models/me_response.rb +2 -2
- data/lib/weft/generated/models/me_response_data.rb +2 -2
- data/lib/weft/generated/models/message_response.rb +2 -2
- data/lib/weft/generated/models/message_response_data.rb +2 -2
- data/lib/weft/generated/models/pagination.rb +2 -2
- data/lib/weft/generated/models/password_reset_request.rb +2 -2
- data/lib/weft/generated/models/password_update_request.rb +2 -2
- data/lib/weft/generated/models/payment.rb +2 -2
- data/lib/weft/generated/models/payment_list_response.rb +2 -2
- data/lib/weft/generated/models/payment_response.rb +2 -2
- data/lib/weft/generated/models/principal_wallet.rb +2 -2
- data/lib/weft/generated/models/promo_balance.rb +2 -2
- data/lib/weft/generated/models/purchase.rb +75 -3
- data/lib/weft/generated/models/purchase_artifact.rb +2 -2
- data/lib/weft/generated/models/purchase_list_response.rb +2 -2
- data/lib/weft/generated/models/purchase_response.rb +2 -2
- data/lib/weft/generated/models/rate_limit_response.rb +2 -2
- data/lib/weft/generated/models/resend_confirmation_request.rb +2 -2
- data/lib/weft/generated/models/resource_enrollment_request.rb +2 -2
- data/lib/weft/generated/models/resource_enrollment_response.rb +2 -2
- data/lib/weft/generated/models/resource_stats.rb +2 -2
- data/lib/weft/generated/models/search_access_method.rb +2 -2
- data/lib/weft/generated/models/search_capability_ref.rb +2 -2
- data/lib/weft/generated/models/search_compact_access.rb +179 -0
- data/lib/weft/generated/models/search_compact_access_price.rb +176 -0
- data/lib/weft/generated/models/search_compact_next_call.rb +275 -0
- data/lib/weft/generated/models/search_compact_result.rb +389 -0
- data/lib/weft/generated/models/search_compact_result_attribution.rb +166 -0
- data/lib/weft/generated/models/search_compact_result_blocked_scopes_inner.rb +156 -0
- data/lib/weft/generated/models/search_compact_result_operation.rb +183 -0
- data/lib/weft/generated/models/search_compact_result_provider.rb +156 -0
- data/lib/weft/generated/models/search_curated_callability.rb +2 -2
- data/lib/weft/generated/models/search_curated_execution.rb +2 -2
- data/lib/weft/generated/models/search_curated_operation.rb +2 -2
- data/lib/weft/generated/models/search_curated_service.rb +2 -2
- data/lib/weft/generated/models/search_curated_source.rb +2 -2
- data/lib/weft/generated/models/search_endpoint_call.rb +4 -4
- data/lib/weft/generated/models/search_endpoint_call_input_schema.rb +103 -0
- data/lib/weft/generated/models/search_endpoint_hit.rb +25 -6
- data/lib/weft/generated/models/search_endpoint_price.rb +2 -2
- data/lib/weft/generated/models/search_error_response.rb +4 -4
- data/lib/weft/generated/models/search_execution_mode_filter.rb +2 -2
- data/lib/weft/generated/models/search_filter_spec.rb +2 -2
- data/lib/weft/generated/models/search_helper_docs.rb +175 -0
- data/lib/weft/generated/models/search_method_filter.rb +2 -2
- data/lib/weft/generated/models/search_payment_offer.rb +2 -2
- data/lib/weft/generated/models/search_price_atomic_filter.rb +2 -2
- data/lib/weft/generated/models/search_price_usd_filter.rb +2 -2
- data/lib/weft/generated/models/search_protocol_filter.rb +2 -2
- data/lib/weft/generated/models/search_provider_ref.rb +2 -2
- data/lib/weft/generated/models/search_request.rb +50 -6
- data/lib/weft/generated/models/search_resource_type_filter.rb +2 -2
- data/lib/weft/generated/models/search_response.rb +71 -8
- data/lib/weft/generated/models/search_response_warnings_inner.rb +2 -2
- data/lib/weft/generated/models/search_result.rb +2 -2
- data/lib/weft/generated/models/search_string_set_filter.rb +2 -2
- data/lib/weft/generated/models/search_weft_fetch_compatibility.rb +28 -6
- data/lib/weft/generated/models/sign_in_request.rb +2 -2
- data/lib/weft/generated/models/sign_up_request.rb +2 -2
- data/lib/weft/generated/models/spending_policy.rb +2 -2
- data/lib/weft/generated/models/user.rb +2 -2
- data/lib/weft/generated/models/user_principal.rb +2 -2
- data/lib/weft/generated/models/wallet.rb +2 -2
- data/lib/weft/generated/version.rb +3 -3
- data/lib/weft/sdk.rb +3 -1
- metadata +39 -8
- data/docs/CuratedMarketplaceContract.md +0 -31
- data/docs/Merchant.md +0 -23
- data/lib/weft/generated/models/curated_marketplace_contract.rb +0 -384
- data/lib/weft/generated/models/merchant.rb +0 -264
data/docs/SearchResponse.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **query** | **String** | | |
|
|
9
9
|
| **format** | **String** | Which view this response carries, echoing the requested format. `json` populates `results` and leaves `markdown` null; `markdown` populates `markdown` and leaves `results` empty. Exactly one is populated per response, never both — returning both eagerly would double the payload. | [optional] |
|
|
10
10
|
| **markdown** | **String** | The flat comparison table, when `format` is `markdown`; null otherwise. Rendered deterministically from the same stored result the `json` view returns, so the two views of one search can never disagree. | [optional] |
|
|
11
|
-
| **result_count** | **Integer** | How many `(Provider + Capability)` results the search produced. Read THIS, not `results.length`, for the count: on a `markdown` response `results` is empty by design, so `result_count > 0` with an empty `results` is a rendered table while `result_count == 0` is a genuine zero-result. | [optional] |
|
|
11
|
+
| **result_count** | **Integer** | How many `(Provider + Capability)` results the search produced. Read THIS, not `results.length`, for the count: on a `markdown` response `results` is empty by design, so `result_count > 0` with an empty `results` is a rendered table while `result_count == 0` is a genuine zero-result. On a `compact` view response it counts `compact_results`; there, `result_count == 0` with `omitted_results` means every ranked result was too large to show. | [optional] |
|
|
12
12
|
| **served_from** | **String** | `live` for a fresh serve; `snapshot` for an immutable replay of a completed search. A re-read is a snapshot and says so — read it with `as_of` and `stale`. | [optional] |
|
|
13
13
|
| **as_of** | **Time** | When the results were produced. Now on a `live` serve; on a `snapshot` the ORIGINAL serve time, because a replay returns exactly what was paid for, not current truth. | [optional] |
|
|
14
14
|
| **stale** | **Boolean** | Whether the active search index has changed since these results were produced. `true` does not mean the results are wrong — it means they are a snapshot of an index that has since moved. Always `false` on a `live` serve. | [optional] |
|
|
@@ -21,7 +21,10 @@
|
|
|
21
21
|
| **match_quality** | **String** | Calibrated confidence in this result set — read this instead of thresholding a raw similarity score. `strong`: the top match is confidently on-intent, proceed. `weak`: above the relevance floor but inside the band where plausible-but-wrong matches live, verify the result before paying. `none`: nothing cleared the floor — `results` is empty and `reason` / `suggestion` say why. Results below the floor are never returned as near-misses. | [optional][default to 'none'] |
|
|
22
22
|
| **reason** | **String** | Machine-readable cause of an empty result set, non-null exactly when `match_quality` is `none`. `below_relevance_floor`: candidates ranked but the best scored under the floor. `filter_collapsed_pool`: a caller filter cut the pool before ranking and nothing relevant survived — relax the filter. `no_catalog_coverage`: recall returned no candidates at all on an unfiltered query. `unsupported_filter_value`: a CATEGORICAL filter value (`type` / `protocol`) matches zero stored values, so it could never have matched — categorical only, since a continuous bound like `price` that matches nothing is reported as `filter_collapsed_pool` instead (the bound needs raising, the dimension is not unsupported). `index_unavailable`: no active index — an operational fault, paired with the `EMPTY_INDEX` warning. | [optional] |
|
|
23
23
|
| **suggestion** | **String** | Human/agent-readable explanation of `reason`, carrying the concrete numbers behind it (pool sizes, the best discarded score against the floor, the values actually stored for a filter). Non-null exactly when `reason` is. | [optional] |
|
|
24
|
-
| **results** | [**Array<SearchResult>**](SearchResult.md) | Ranked `(Provider + Capability)` results; empty when the index is empty or nothing cleared the relevance floor. Results BELOW the floor are never returned — an empty list plus a `reason` is the honest answer, not a list of near-misses in the same shape as a genuine match. | |
|
|
24
|
+
| **results** | [**Array<SearchResult>**](SearchResult.md) | Ranked `(Provider + Capability)` results; empty when the index is empty or nothing cleared the relevance floor. Results BELOW the floor are never returned — an empty list plus a `reason` is the honest answer, not a list of near-misses in the same shape as a genuine match. Empty on a `compact` view response; read `compact_results`. | |
|
|
25
|
+
| **view** | **String** | The view this response carries. Present as `compact` when the request asked for `view: \"compact\"`; absent means `full`. | [optional] |
|
|
26
|
+
| **compact_results** | [**Array<SearchCompactResult>**](SearchCompactResult.md) | Ranked compact results, present only on a `compact` view response. `result_count` is their count. They are a separate field so that typed clients keep the full `SearchResult` shape for `results`. | [optional] |
|
|
27
|
+
| **omitted_results** | **Integer** | Compact view only: how many ranked results were left out because even their minimum summary does not fit the per-result budget. Absent when none were left out. | [optional] |
|
|
25
28
|
|
|
26
29
|
## Example
|
|
27
30
|
|
|
@@ -46,6 +49,9 @@ instance = Weft::SearchResponse.new(
|
|
|
46
49
|
match_quality: null,
|
|
47
50
|
reason: null,
|
|
48
51
|
suggestion: null,
|
|
49
|
-
results: null
|
|
52
|
+
results: null,
|
|
53
|
+
view: null,
|
|
54
|
+
compact_results: null,
|
|
55
|
+
omitted_results: null
|
|
50
56
|
)
|
|
51
57
|
```
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **state** | **String** | | |
|
|
8
8
|
| **reason** | **String** | | |
|
|
9
9
|
| **contract_version** | **Integer** | | |
|
|
10
|
+
| **coverage** | **String** | Extent of the operation covered by weft_fetch. `terminal_response` covers the terminal result; `submission_only` covers submission but not completion or retrieval of the result; `none` means no coverage. When absent, coverage is unknown, not terminal. Do not infer terminal coverage from synchronous execution mode alone. | [optional] |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ require 'weft-sdk'
|
|
|
16
17
|
instance = Weft::SearchWeftFetchCompatibility.new(
|
|
17
18
|
state: null,
|
|
18
19
|
reason: null,
|
|
19
|
-
contract_version: null
|
|
20
|
+
contract_version: null,
|
|
21
|
+
coverage: null
|
|
20
22
|
)
|
|
21
23
|
```
|
data/docs/WebhooksApi.md
ADDED
|
@@ -0,0 +1,414 @@
|
|
|
1
|
+
# Weft::WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://weft.network*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_webhook_endpoint**](WebhooksApi.md#create_webhook_endpoint) | **POST** /api/v1/webhook_endpoints | Create a webhook endpoint |
|
|
8
|
+
| [**delete_webhook_endpoint**](WebhooksApi.md#delete_webhook_endpoint) | **DELETE** /api/v1/webhook_endpoints/{id} | Delete a webhook endpoint |
|
|
9
|
+
| [**get_webhook_endpoint**](WebhooksApi.md#get_webhook_endpoint) | **GET** /api/v1/webhook_endpoints/{id} | Get a webhook endpoint |
|
|
10
|
+
| [**list_webhook_endpoints**](WebhooksApi.md#list_webhook_endpoints) | **GET** /api/v1/webhook_endpoints | List webhook endpoints |
|
|
11
|
+
| [**replace_webhook_endpoint**](WebhooksApi.md#replace_webhook_endpoint) | **PUT** /api/v1/webhook_endpoints/{id} | Replace a webhook endpoint |
|
|
12
|
+
| [**update_webhook_endpoint**](WebhooksApi.md#update_webhook_endpoint) | **PATCH** /api/v1/webhook_endpoints/{id} | Update a webhook endpoint |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## create_webhook_endpoint
|
|
16
|
+
|
|
17
|
+
> create_webhook_endpoint
|
|
18
|
+
|
|
19
|
+
Create a webhook endpoint
|
|
20
|
+
|
|
21
|
+
Retired. Returns HTTP 410 with error code `gone`. The body is ignored.
|
|
22
|
+
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'time'
|
|
27
|
+
require 'weft-sdk'
|
|
28
|
+
# setup authorization
|
|
29
|
+
Weft.configure do |config|
|
|
30
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
api_instance = Weft::WebhooksApi.new
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
# Create a webhook endpoint
|
|
38
|
+
api_instance.create_webhook_endpoint
|
|
39
|
+
rescue Weft::ApiError => e
|
|
40
|
+
puts "Error when calling WebhooksApi->create_webhook_endpoint: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the create_webhook_endpoint_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(nil, Integer, Hash)> create_webhook_endpoint_with_http_info
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Create a webhook endpoint
|
|
53
|
+
data, status_code, headers = api_instance.create_webhook_endpoint_with_http_info
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => nil
|
|
57
|
+
rescue Weft::ApiError => e
|
|
58
|
+
puts "Error when calling WebhooksApi->create_webhook_endpoint_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
This endpoint does not need any parameter.
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
nil (empty response body)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: Not defined
|
|
77
|
+
- **Accept**: application/json
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## delete_webhook_endpoint
|
|
81
|
+
|
|
82
|
+
> delete_webhook_endpoint(id)
|
|
83
|
+
|
|
84
|
+
Delete a webhook endpoint
|
|
85
|
+
|
|
86
|
+
Retired. Returns HTTP 410 with error code `gone`. Stored rows are kept.
|
|
87
|
+
|
|
88
|
+
### Examples
|
|
89
|
+
|
|
90
|
+
```ruby
|
|
91
|
+
require 'time'
|
|
92
|
+
require 'weft-sdk'
|
|
93
|
+
# setup authorization
|
|
94
|
+
Weft.configure do |config|
|
|
95
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
96
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
api_instance = Weft::WebhooksApi.new
|
|
100
|
+
id = 56 # Integer | Webhook endpoint ID. Ignored. The response is always HTTP 410.
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
# Delete a webhook endpoint
|
|
104
|
+
api_instance.delete_webhook_endpoint(id)
|
|
105
|
+
rescue Weft::ApiError => e
|
|
106
|
+
puts "Error when calling WebhooksApi->delete_webhook_endpoint: #{e}"
|
|
107
|
+
end
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
#### Using the delete_webhook_endpoint_with_http_info variant
|
|
111
|
+
|
|
112
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
113
|
+
|
|
114
|
+
> <Array(nil, Integer, Hash)> delete_webhook_endpoint_with_http_info(id)
|
|
115
|
+
|
|
116
|
+
```ruby
|
|
117
|
+
begin
|
|
118
|
+
# Delete a webhook endpoint
|
|
119
|
+
data, status_code, headers = api_instance.delete_webhook_endpoint_with_http_info(id)
|
|
120
|
+
p status_code # => 2xx
|
|
121
|
+
p headers # => { ... }
|
|
122
|
+
p data # => nil
|
|
123
|
+
rescue Weft::ApiError => e
|
|
124
|
+
puts "Error when calling WebhooksApi->delete_webhook_endpoint_with_http_info: #{e}"
|
|
125
|
+
end
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
| Name | Type | Description | Notes |
|
|
131
|
+
| ---- | ---- | ----------- | ----- |
|
|
132
|
+
| **id** | **Integer** | Webhook endpoint ID. Ignored. The response is always HTTP 410. | |
|
|
133
|
+
|
|
134
|
+
### Return type
|
|
135
|
+
|
|
136
|
+
nil (empty response body)
|
|
137
|
+
|
|
138
|
+
### Authorization
|
|
139
|
+
|
|
140
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
141
|
+
|
|
142
|
+
### HTTP request headers
|
|
143
|
+
|
|
144
|
+
- **Content-Type**: Not defined
|
|
145
|
+
- **Accept**: application/json
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
## get_webhook_endpoint
|
|
149
|
+
|
|
150
|
+
> get_webhook_endpoint(id)
|
|
151
|
+
|
|
152
|
+
Get a webhook endpoint
|
|
153
|
+
|
|
154
|
+
Retired. Returns HTTP 410 with error code `gone`.
|
|
155
|
+
|
|
156
|
+
### Examples
|
|
157
|
+
|
|
158
|
+
```ruby
|
|
159
|
+
require 'time'
|
|
160
|
+
require 'weft-sdk'
|
|
161
|
+
# setup authorization
|
|
162
|
+
Weft.configure do |config|
|
|
163
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
164
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
api_instance = Weft::WebhooksApi.new
|
|
168
|
+
id = 56 # Integer | Webhook endpoint ID. Ignored. The response is always HTTP 410.
|
|
169
|
+
|
|
170
|
+
begin
|
|
171
|
+
# Get a webhook endpoint
|
|
172
|
+
api_instance.get_webhook_endpoint(id)
|
|
173
|
+
rescue Weft::ApiError => e
|
|
174
|
+
puts "Error when calling WebhooksApi->get_webhook_endpoint: #{e}"
|
|
175
|
+
end
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
#### Using the get_webhook_endpoint_with_http_info variant
|
|
179
|
+
|
|
180
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
181
|
+
|
|
182
|
+
> <Array(nil, Integer, Hash)> get_webhook_endpoint_with_http_info(id)
|
|
183
|
+
|
|
184
|
+
```ruby
|
|
185
|
+
begin
|
|
186
|
+
# Get a webhook endpoint
|
|
187
|
+
data, status_code, headers = api_instance.get_webhook_endpoint_with_http_info(id)
|
|
188
|
+
p status_code # => 2xx
|
|
189
|
+
p headers # => { ... }
|
|
190
|
+
p data # => nil
|
|
191
|
+
rescue Weft::ApiError => e
|
|
192
|
+
puts "Error when calling WebhooksApi->get_webhook_endpoint_with_http_info: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
| Name | Type | Description | Notes |
|
|
199
|
+
| ---- | ---- | ----------- | ----- |
|
|
200
|
+
| **id** | **Integer** | Webhook endpoint ID. Ignored. The response is always HTTP 410. | |
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
nil (empty response body)
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
## list_webhook_endpoints
|
|
217
|
+
|
|
218
|
+
> list_webhook_endpoints
|
|
219
|
+
|
|
220
|
+
List webhook endpoints
|
|
221
|
+
|
|
222
|
+
Retired. Returns HTTP 410 with error code `gone`.
|
|
223
|
+
|
|
224
|
+
### Examples
|
|
225
|
+
|
|
226
|
+
```ruby
|
|
227
|
+
require 'time'
|
|
228
|
+
require 'weft-sdk'
|
|
229
|
+
# setup authorization
|
|
230
|
+
Weft.configure do |config|
|
|
231
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
232
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
api_instance = Weft::WebhooksApi.new
|
|
236
|
+
|
|
237
|
+
begin
|
|
238
|
+
# List webhook endpoints
|
|
239
|
+
api_instance.list_webhook_endpoints
|
|
240
|
+
rescue Weft::ApiError => e
|
|
241
|
+
puts "Error when calling WebhooksApi->list_webhook_endpoints: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
#### Using the list_webhook_endpoints_with_http_info variant
|
|
246
|
+
|
|
247
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
248
|
+
|
|
249
|
+
> <Array(nil, Integer, Hash)> list_webhook_endpoints_with_http_info
|
|
250
|
+
|
|
251
|
+
```ruby
|
|
252
|
+
begin
|
|
253
|
+
# List webhook endpoints
|
|
254
|
+
data, status_code, headers = api_instance.list_webhook_endpoints_with_http_info
|
|
255
|
+
p status_code # => 2xx
|
|
256
|
+
p headers # => { ... }
|
|
257
|
+
p data # => nil
|
|
258
|
+
rescue Weft::ApiError => e
|
|
259
|
+
puts "Error when calling WebhooksApi->list_webhook_endpoints_with_http_info: #{e}"
|
|
260
|
+
end
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
This endpoint does not need any parameter.
|
|
266
|
+
|
|
267
|
+
### Return type
|
|
268
|
+
|
|
269
|
+
nil (empty response body)
|
|
270
|
+
|
|
271
|
+
### Authorization
|
|
272
|
+
|
|
273
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
274
|
+
|
|
275
|
+
### HTTP request headers
|
|
276
|
+
|
|
277
|
+
- **Content-Type**: Not defined
|
|
278
|
+
- **Accept**: application/json
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
## replace_webhook_endpoint
|
|
282
|
+
|
|
283
|
+
> replace_webhook_endpoint(id)
|
|
284
|
+
|
|
285
|
+
Replace a webhook endpoint
|
|
286
|
+
|
|
287
|
+
Retired. Returns HTTP 410 with error code `gone`. The body is ignored.
|
|
288
|
+
|
|
289
|
+
### Examples
|
|
290
|
+
|
|
291
|
+
```ruby
|
|
292
|
+
require 'time'
|
|
293
|
+
require 'weft-sdk'
|
|
294
|
+
# setup authorization
|
|
295
|
+
Weft.configure do |config|
|
|
296
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
297
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
api_instance = Weft::WebhooksApi.new
|
|
301
|
+
id = 56 # Integer | Webhook endpoint ID. Ignored. The response is always HTTP 410.
|
|
302
|
+
|
|
303
|
+
begin
|
|
304
|
+
# Replace a webhook endpoint
|
|
305
|
+
api_instance.replace_webhook_endpoint(id)
|
|
306
|
+
rescue Weft::ApiError => e
|
|
307
|
+
puts "Error when calling WebhooksApi->replace_webhook_endpoint: #{e}"
|
|
308
|
+
end
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
#### Using the replace_webhook_endpoint_with_http_info variant
|
|
312
|
+
|
|
313
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
314
|
+
|
|
315
|
+
> <Array(nil, Integer, Hash)> replace_webhook_endpoint_with_http_info(id)
|
|
316
|
+
|
|
317
|
+
```ruby
|
|
318
|
+
begin
|
|
319
|
+
# Replace a webhook endpoint
|
|
320
|
+
data, status_code, headers = api_instance.replace_webhook_endpoint_with_http_info(id)
|
|
321
|
+
p status_code # => 2xx
|
|
322
|
+
p headers # => { ... }
|
|
323
|
+
p data # => nil
|
|
324
|
+
rescue Weft::ApiError => e
|
|
325
|
+
puts "Error when calling WebhooksApi->replace_webhook_endpoint_with_http_info: #{e}"
|
|
326
|
+
end
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
### Parameters
|
|
330
|
+
|
|
331
|
+
| Name | Type | Description | Notes |
|
|
332
|
+
| ---- | ---- | ----------- | ----- |
|
|
333
|
+
| **id** | **Integer** | Webhook endpoint ID. Ignored. The response is always HTTP 410. | |
|
|
334
|
+
|
|
335
|
+
### Return type
|
|
336
|
+
|
|
337
|
+
nil (empty response body)
|
|
338
|
+
|
|
339
|
+
### Authorization
|
|
340
|
+
|
|
341
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
342
|
+
|
|
343
|
+
### HTTP request headers
|
|
344
|
+
|
|
345
|
+
- **Content-Type**: Not defined
|
|
346
|
+
- **Accept**: application/json
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
## update_webhook_endpoint
|
|
350
|
+
|
|
351
|
+
> update_webhook_endpoint(id)
|
|
352
|
+
|
|
353
|
+
Update a webhook endpoint
|
|
354
|
+
|
|
355
|
+
Retired. Returns HTTP 410 with error code `gone`. The body is ignored.
|
|
356
|
+
|
|
357
|
+
### Examples
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
require 'time'
|
|
361
|
+
require 'weft-sdk'
|
|
362
|
+
# setup authorization
|
|
363
|
+
Weft.configure do |config|
|
|
364
|
+
# Configure Bearer authorization (APIKey): bearerAuth
|
|
365
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
api_instance = Weft::WebhooksApi.new
|
|
369
|
+
id = 56 # Integer | Webhook endpoint ID. Ignored. The response is always HTTP 410.
|
|
370
|
+
|
|
371
|
+
begin
|
|
372
|
+
# Update a webhook endpoint
|
|
373
|
+
api_instance.update_webhook_endpoint(id)
|
|
374
|
+
rescue Weft::ApiError => e
|
|
375
|
+
puts "Error when calling WebhooksApi->update_webhook_endpoint: #{e}"
|
|
376
|
+
end
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
#### Using the update_webhook_endpoint_with_http_info variant
|
|
380
|
+
|
|
381
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
382
|
+
|
|
383
|
+
> <Array(nil, Integer, Hash)> update_webhook_endpoint_with_http_info(id)
|
|
384
|
+
|
|
385
|
+
```ruby
|
|
386
|
+
begin
|
|
387
|
+
# Update a webhook endpoint
|
|
388
|
+
data, status_code, headers = api_instance.update_webhook_endpoint_with_http_info(id)
|
|
389
|
+
p status_code # => 2xx
|
|
390
|
+
p headers # => { ... }
|
|
391
|
+
p data # => nil
|
|
392
|
+
rescue Weft::ApiError => e
|
|
393
|
+
puts "Error when calling WebhooksApi->update_webhook_endpoint_with_http_info: #{e}"
|
|
394
|
+
end
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### Parameters
|
|
398
|
+
|
|
399
|
+
| Name | Type | Description | Notes |
|
|
400
|
+
| ---- | ---- | ----------- | ----- |
|
|
401
|
+
| **id** | **Integer** | Webhook endpoint ID. Ignored. The response is always HTTP 410. | |
|
|
402
|
+
|
|
403
|
+
### Return type
|
|
404
|
+
|
|
405
|
+
nil (empty response body)
|
|
406
|
+
|
|
407
|
+
### Authorization
|
|
408
|
+
|
|
409
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
410
|
+
|
|
411
|
+
### HTTP request headers
|
|
412
|
+
|
|
413
|
+
- **Content-Type**: Not defined
|
|
414
|
+
- **Accept**: application/json
|