fastcomments 1.2.0 → 1.2.1
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/client/README.md +27 -0
- data/client/docs/APIComment.md +1 -1
- data/client/docs/APICommentBase.md +1 -1
- data/client/docs/APICommentBaseMeta.md +20 -0
- data/client/docs/APITicket.md +34 -0
- data/client/docs/APITicketDetail.md +42 -0
- data/client/docs/APITicketFile.md +36 -0
- data/client/docs/APIUserSubscription.md +2 -0
- data/client/docs/ChangeTicketState200Response.md +34 -0
- data/client/docs/ChangeTicketStateBody.md +18 -0
- data/client/docs/ChangeTicketStateResponse.md +20 -0
- data/client/docs/CommentData.md +3 -1
- data/client/docs/CreateAPIUserSubscriptionData.md +2 -0
- data/client/docs/CreateCommentParams.md +2 -0
- data/client/docs/CreateTenantPackageBody.md +2 -0
- data/client/docs/CreateTicket200Response.md +34 -0
- data/client/docs/CreateTicketBody.md +18 -0
- data/client/docs/CreateTicketResponse.md +20 -0
- data/client/docs/CustomConfigParameters.md +21 -1
- data/client/docs/DefaultApi.md +384 -0
- data/client/docs/FComment.md +3 -1
- data/client/docs/FCommentMeta.md +2 -0
- data/client/docs/GetTicket200Response.md +36 -0
- data/client/docs/GetTicketResponse.md +22 -0
- data/client/docs/GetTickets200Response.md +34 -0
- data/client/docs/GetTicketsResponse.md +20 -0
- data/client/docs/HeaderAccountNotification.md +34 -0
- data/client/docs/HeaderState.md +3 -1
- data/client/docs/MentionAutoCompleteMode.md +15 -0
- data/client/docs/Moderator.md +3 -1
- data/client/docs/PublicApi.md +3 -1
- data/client/docs/ReplaceTenantPackageBody.md +2 -0
- data/client/docs/SearchUsers200Response.md +2 -0
- data/client/docs/SearchUsersSectionedResponse.md +20 -0
- data/client/docs/TOSConfig.md +22 -0
- data/client/docs/TenantPackage.md +4 -0
- data/client/docs/UpdatableCommentParams.md +1 -1
- data/client/docs/UpdateAPIUserSubscriptionData.md +18 -0
- data/client/docs/UpdateSubscriptionAPIResponse.md +24 -0
- data/client/docs/UpdateTenantPackageBody.md +2 -0
- data/client/docs/User.md +17 -1
- data/client/docs/UserBadge.md +3 -1
- data/client/docs/UserBadgeProgress.md +3 -1
- data/client/docs/UserSearchSection.md +15 -0
- data/client/docs/UserSearchSectionResult.md +20 -0
- data/client/docs/UserSessionInfo.md +2 -0
- data/client/lib/fastcomments-client/api/default_api.rb +383 -0
- data/client/lib/fastcomments-client/api/public_api.rb +7 -0
- data/client/lib/fastcomments-client/models/api_comment.rb +1 -1
- data/client/lib/fastcomments-client/models/api_comment_base.rb +1 -1
- data/client/lib/fastcomments-client/models/api_comment_base_meta.rb +156 -0
- data/client/lib/fastcomments-client/models/api_ticket.rb +374 -0
- data/client/lib/fastcomments-client/models/api_ticket_detail.rb +432 -0
- data/client/lib/fastcomments-client/models/api_ticket_file.rb +381 -0
- data/client/lib/fastcomments-client/models/api_user_subscription.rb +10 -1
- data/client/lib/fastcomments-client/models/change_ticket_state200_response.rb +103 -0
- data/client/lib/fastcomments-client/models/change_ticket_state_body.rb +164 -0
- data/client/lib/fastcomments-client/models/change_ticket_state_response.rb +212 -0
- data/client/lib/fastcomments-client/models/comment_data.rb +13 -4
- data/client/lib/fastcomments-client/models/create_api_user_subscription_data.rb +10 -1
- data/client/lib/fastcomments-client/models/create_comment_params.rb +10 -1
- data/client/lib/fastcomments-client/models/create_tenant_package_body.rb +10 -1
- data/client/lib/fastcomments-client/models/create_ticket200_response.rb +103 -0
- data/client/lib/fastcomments-client/models/create_ticket_body.rb +164 -0
- data/client/lib/fastcomments-client/models/create_ticket_response.rb +212 -0
- data/client/lib/fastcomments-client/models/custom_config_parameters.rb +97 -4
- data/client/lib/fastcomments-client/models/f_comment.rb +13 -4
- data/client/lib/fastcomments-client/models/f_comment_meta.rb +10 -1
- data/client/lib/fastcomments-client/models/get_ticket200_response.rb +103 -0
- data/client/lib/fastcomments-client/models/get_ticket_response.rb +240 -0
- data/client/lib/fastcomments-client/models/get_tickets200_response.rb +103 -0
- data/client/lib/fastcomments-client/models/get_tickets_response.rb +214 -0
- data/client/lib/fastcomments-client/models/header_account_notification.rb +322 -0
- data/client/lib/fastcomments-client/models/header_state.rb +32 -4
- data/client/lib/fastcomments-client/models/mention_auto_complete_mode.rb +41 -0
- data/client/lib/fastcomments-client/models/moderator.rb +14 -5
- data/client/lib/fastcomments-client/models/replace_tenant_package_body.rb +10 -1
- data/client/lib/fastcomments-client/models/search_users200_response.rb +2 -1
- data/client/lib/fastcomments-client/models/search_users_sectioned_response.rb +214 -0
- data/client/lib/fastcomments-client/models/tenant_package.rb +36 -1
- data/client/lib/fastcomments-client/models/tos_config.rb +168 -0
- data/client/lib/fastcomments-client/models/updatable_comment_params.rb +1 -1
- data/client/lib/fastcomments-client/models/update_api_user_subscription_data.rb +147 -0
- data/client/lib/fastcomments-client/models/update_subscription_api_response.rb +191 -0
- data/client/lib/fastcomments-client/models/update_tenant_package_body.rb +10 -1
- data/client/lib/fastcomments-client/models/user.rb +76 -4
- data/client/lib/fastcomments-client/models/user_badge.rb +14 -4
- data/client/lib/fastcomments-client/models/user_badge_progress.rb +13 -4
- data/client/lib/fastcomments-client/models/user_search_section.rb +41 -0
- data/client/lib/fastcomments-client/models/user_search_section_result.rb +214 -0
- data/client/lib/fastcomments-client/models/user_session_info.rb +10 -1
- data/client/lib/fastcomments-client.rb +22 -0
- data/client/spec/api/default_api_spec.rb +64 -0
- data/client/spec/api/public_api_spec.rb +1 -0
- data/client/spec/models/api_comment_base_meta_spec.rb +42 -0
- data/client/spec/models/api_ticket_detail_spec.rb +108 -0
- data/client/spec/models/api_ticket_file_spec.rb +90 -0
- data/client/spec/models/api_ticket_spec.rb +84 -0
- data/client/spec/models/api_user_subscription_spec.rb +6 -0
- data/client/spec/models/change_ticket_state200_response_spec.rb +21 -0
- data/client/spec/models/change_ticket_state_body_spec.rb +36 -0
- data/client/spec/models/change_ticket_state_response_spec.rb +42 -0
- data/client/spec/models/comment_data_spec.rb +6 -0
- data/client/spec/models/create_api_user_subscription_data_spec.rb +6 -0
- data/client/spec/models/create_comment_params_spec.rb +6 -0
- data/client/spec/models/create_tenant_package_body_spec.rb +6 -0
- data/client/spec/models/create_ticket200_response_spec.rb +21 -0
- data/client/spec/models/create_ticket_body_spec.rb +36 -0
- data/client/spec/models/create_ticket_response_spec.rb +42 -0
- data/client/spec/models/custom_config_parameters_spec.rb +60 -0
- data/client/spec/models/f_comment_meta_spec.rb +6 -0
- data/client/spec/models/f_comment_spec.rb +6 -0
- data/client/spec/models/get_ticket200_response_spec.rb +21 -0
- data/client/spec/models/get_ticket_response_spec.rb +48 -0
- data/client/spec/models/get_tickets200_response_spec.rb +21 -0
- data/client/spec/models/get_tickets_response_spec.rb +42 -0
- data/client/spec/models/header_account_notification_spec.rb +84 -0
- data/client/spec/models/header_state_spec.rb +6 -0
- data/client/spec/models/mention_auto_complete_mode_spec.rb +30 -0
- data/client/spec/models/moderator_spec.rb +6 -0
- data/client/spec/models/replace_tenant_package_body_spec.rb +6 -0
- data/client/spec/models/search_users_sectioned_response_spec.rb +42 -0
- data/client/spec/models/tenant_package_spec.rb +12 -0
- data/client/spec/models/tos_config_spec.rb +48 -0
- data/client/spec/models/update_api_user_subscription_data_spec.rb +36 -0
- data/client/spec/models/update_subscription_api_response_spec.rb +54 -0
- data/client/spec/models/update_tenant_package_body_spec.rb +6 -0
- data/client/spec/models/user_badge_progress_spec.rb +6 -0
- data/client/spec/models/user_badge_spec.rb +6 -0
- data/client/spec/models/user_search_section_result_spec.rb +42 -0
- data/client/spec/models/user_search_section_spec.rb +30 -0
- data/client/spec/models/user_session_info_spec.rb +6 -0
- data/client/spec/models/user_spec.rb +48 -0
- data/lib/fastcomments.rb +1 -1
- metadata +68 -2
data/client/docs/DefaultApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://fastcomments.com*
|
|
|
13
13
|
| [**aggregate_question_results**](DefaultApi.md#aggregate_question_results) | **GET** /api/v1/question-results-aggregation | |
|
|
14
14
|
| [**block_user_from_comment**](DefaultApi.md#block_user_from_comment) | **POST** /api/v1/comments/{id}/block | |
|
|
15
15
|
| [**bulk_aggregate_question_results**](DefaultApi.md#bulk_aggregate_question_results) | **POST** /api/v1/question-results-aggregation/bulk | |
|
|
16
|
+
| [**change_ticket_state**](DefaultApi.md#change_ticket_state) | **PATCH** /api/v1/tickets/{id}/state | |
|
|
16
17
|
| [**combine_comments_with_question_results**](DefaultApi.md#combine_comments_with_question_results) | **GET** /api/v1/question-results-aggregation/combine/comments | |
|
|
17
18
|
| [**create_email_template**](DefaultApi.md#create_email_template) | **POST** /api/v1/email-templates | |
|
|
18
19
|
| [**create_feed_post**](DefaultApi.md#create_feed_post) | **POST** /api/v1/feed-posts | |
|
|
@@ -23,6 +24,7 @@ All URIs are relative to *https://fastcomments.com*
|
|
|
23
24
|
| [**create_tenant**](DefaultApi.md#create_tenant) | **POST** /api/v1/tenants | |
|
|
24
25
|
| [**create_tenant_package**](DefaultApi.md#create_tenant_package) | **POST** /api/v1/tenant-packages | |
|
|
25
26
|
| [**create_tenant_user**](DefaultApi.md#create_tenant_user) | **POST** /api/v1/tenant-users | |
|
|
27
|
+
| [**create_ticket**](DefaultApi.md#create_ticket) | **POST** /api/v1/tickets | |
|
|
26
28
|
| [**create_user_badge**](DefaultApi.md#create_user_badge) | **POST** /api/v1/user-badges | |
|
|
27
29
|
| [**create_vote**](DefaultApi.md#create_vote) | **POST** /api/v1/votes | |
|
|
28
30
|
| [**delete_comment**](DefaultApi.md#delete_comment) | **DELETE** /api/v1/comments/{id} | |
|
|
@@ -79,6 +81,8 @@ All URIs are relative to *https://fastcomments.com*
|
|
|
79
81
|
| [**get_tenant_user**](DefaultApi.md#get_tenant_user) | **GET** /api/v1/tenant-users/{id} | |
|
|
80
82
|
| [**get_tenant_users**](DefaultApi.md#get_tenant_users) | **GET** /api/v1/tenant-users | |
|
|
81
83
|
| [**get_tenants**](DefaultApi.md#get_tenants) | **GET** /api/v1/tenants | |
|
|
84
|
+
| [**get_ticket**](DefaultApi.md#get_ticket) | **GET** /api/v1/tickets/{id} | |
|
|
85
|
+
| [**get_tickets**](DefaultApi.md#get_tickets) | **GET** /api/v1/tickets | |
|
|
82
86
|
| [**get_user**](DefaultApi.md#get_user) | **GET** /api/v1/users/{id} | |
|
|
83
87
|
| [**get_user_badge**](DefaultApi.md#get_user_badge) | **GET** /api/v1/user-badges/{id} | |
|
|
84
88
|
| [**get_user_badge_progress_by_id**](DefaultApi.md#get_user_badge_progress_by_id) | **GET** /api/v1/user-badge-progress/{id} | |
|
|
@@ -109,6 +113,7 @@ All URIs are relative to *https://fastcomments.com*
|
|
|
109
113
|
| [**update_notification**](DefaultApi.md#update_notification) | **PATCH** /api/v1/notifications/{id} | |
|
|
110
114
|
| [**update_question_config**](DefaultApi.md#update_question_config) | **PATCH** /api/v1/question-configs/{id} | |
|
|
111
115
|
| [**update_question_result**](DefaultApi.md#update_question_result) | **PATCH** /api/v1/question-results/{id} | |
|
|
116
|
+
| [**update_subscription**](DefaultApi.md#update_subscription) | **PATCH** /api/v1/subscriptions/{id} | |
|
|
112
117
|
| [**update_tenant**](DefaultApi.md#update_tenant) | **PATCH** /api/v1/tenants/{id} | |
|
|
113
118
|
| [**update_tenant_package**](DefaultApi.md#update_tenant_package) | **PATCH** /api/v1/tenant-packages/{id} | |
|
|
114
119
|
| [**update_tenant_user**](DefaultApi.md#update_tenant_user) | **PATCH** /api/v1/tenant-users/{id} | |
|
|
@@ -790,6 +795,81 @@ end
|
|
|
790
795
|
- **Accept**: application/json
|
|
791
796
|
|
|
792
797
|
|
|
798
|
+
## change_ticket_state
|
|
799
|
+
|
|
800
|
+
> <ChangeTicketState200Response> change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
### Examples
|
|
805
|
+
|
|
806
|
+
```ruby
|
|
807
|
+
require 'time'
|
|
808
|
+
require 'fastcomments-client'
|
|
809
|
+
# setup authorization
|
|
810
|
+
FastCommentsClient.configure do |config|
|
|
811
|
+
# Configure API key authorization: api_key
|
|
812
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
813
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
814
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
815
|
+
end
|
|
816
|
+
|
|
817
|
+
api_instance = FastCommentsClient::DefaultApi.new
|
|
818
|
+
tenant_id = 'tenant_id_example' # String |
|
|
819
|
+
user_id = 'user_id_example' # String |
|
|
820
|
+
id = 'id_example' # String |
|
|
821
|
+
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody |
|
|
822
|
+
|
|
823
|
+
begin
|
|
824
|
+
|
|
825
|
+
result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
|
|
826
|
+
p result
|
|
827
|
+
rescue FastCommentsClient::ApiError => e
|
|
828
|
+
puts "Error when calling DefaultApi->change_ticket_state: #{e}"
|
|
829
|
+
end
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
#### Using the change_ticket_state_with_http_info variant
|
|
833
|
+
|
|
834
|
+
This returns an Array which contains the response data, status code and headers.
|
|
835
|
+
|
|
836
|
+
> <Array(<ChangeTicketState200Response>, Integer, Hash)> change_ticket_state_with_http_info(tenant_id, user_id, id, change_ticket_state_body)
|
|
837
|
+
|
|
838
|
+
```ruby
|
|
839
|
+
begin
|
|
840
|
+
|
|
841
|
+
data, status_code, headers = api_instance.change_ticket_state_with_http_info(tenant_id, user_id, id, change_ticket_state_body)
|
|
842
|
+
p status_code # => 2xx
|
|
843
|
+
p headers # => { ... }
|
|
844
|
+
p data # => <ChangeTicketState200Response>
|
|
845
|
+
rescue FastCommentsClient::ApiError => e
|
|
846
|
+
puts "Error when calling DefaultApi->change_ticket_state_with_http_info: #{e}"
|
|
847
|
+
end
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
### Parameters
|
|
851
|
+
|
|
852
|
+
| Name | Type | Description | Notes |
|
|
853
|
+
| ---- | ---- | ----------- | ----- |
|
|
854
|
+
| **tenant_id** | **String** | | |
|
|
855
|
+
| **user_id** | **String** | | |
|
|
856
|
+
| **id** | **String** | | |
|
|
857
|
+
| **change_ticket_state_body** | [**ChangeTicketStateBody**](ChangeTicketStateBody.md) | | |
|
|
858
|
+
|
|
859
|
+
### Return type
|
|
860
|
+
|
|
861
|
+
[**ChangeTicketState200Response**](ChangeTicketState200Response.md)
|
|
862
|
+
|
|
863
|
+
### Authorization
|
|
864
|
+
|
|
865
|
+
[api_key](../README.md#api_key)
|
|
866
|
+
|
|
867
|
+
### HTTP request headers
|
|
868
|
+
|
|
869
|
+
- **Content-Type**: application/json
|
|
870
|
+
- **Accept**: application/json
|
|
871
|
+
|
|
872
|
+
|
|
793
873
|
## combine_comments_with_question_results
|
|
794
874
|
|
|
795
875
|
> <CombineCommentsWithQuestionResults200Response> combine_comments_with_question_results(tenant_id, opts)
|
|
@@ -1526,6 +1606,79 @@ end
|
|
|
1526
1606
|
- **Accept**: application/json
|
|
1527
1607
|
|
|
1528
1608
|
|
|
1609
|
+
## create_ticket
|
|
1610
|
+
|
|
1611
|
+
> <CreateTicket200Response> create_ticket(tenant_id, user_id, create_ticket_body)
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
### Examples
|
|
1616
|
+
|
|
1617
|
+
```ruby
|
|
1618
|
+
require 'time'
|
|
1619
|
+
require 'fastcomments-client'
|
|
1620
|
+
# setup authorization
|
|
1621
|
+
FastCommentsClient.configure do |config|
|
|
1622
|
+
# Configure API key authorization: api_key
|
|
1623
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
1624
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1625
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
1626
|
+
end
|
|
1627
|
+
|
|
1628
|
+
api_instance = FastCommentsClient::DefaultApi.new
|
|
1629
|
+
tenant_id = 'tenant_id_example' # String |
|
|
1630
|
+
user_id = 'user_id_example' # String |
|
|
1631
|
+
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody |
|
|
1632
|
+
|
|
1633
|
+
begin
|
|
1634
|
+
|
|
1635
|
+
result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
|
|
1636
|
+
p result
|
|
1637
|
+
rescue FastCommentsClient::ApiError => e
|
|
1638
|
+
puts "Error when calling DefaultApi->create_ticket: #{e}"
|
|
1639
|
+
end
|
|
1640
|
+
```
|
|
1641
|
+
|
|
1642
|
+
#### Using the create_ticket_with_http_info variant
|
|
1643
|
+
|
|
1644
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1645
|
+
|
|
1646
|
+
> <Array(<CreateTicket200Response>, Integer, Hash)> create_ticket_with_http_info(tenant_id, user_id, create_ticket_body)
|
|
1647
|
+
|
|
1648
|
+
```ruby
|
|
1649
|
+
begin
|
|
1650
|
+
|
|
1651
|
+
data, status_code, headers = api_instance.create_ticket_with_http_info(tenant_id, user_id, create_ticket_body)
|
|
1652
|
+
p status_code # => 2xx
|
|
1653
|
+
p headers # => { ... }
|
|
1654
|
+
p data # => <CreateTicket200Response>
|
|
1655
|
+
rescue FastCommentsClient::ApiError => e
|
|
1656
|
+
puts "Error when calling DefaultApi->create_ticket_with_http_info: #{e}"
|
|
1657
|
+
end
|
|
1658
|
+
```
|
|
1659
|
+
|
|
1660
|
+
### Parameters
|
|
1661
|
+
|
|
1662
|
+
| Name | Type | Description | Notes |
|
|
1663
|
+
| ---- | ---- | ----------- | ----- |
|
|
1664
|
+
| **tenant_id** | **String** | | |
|
|
1665
|
+
| **user_id** | **String** | | |
|
|
1666
|
+
| **create_ticket_body** | [**CreateTicketBody**](CreateTicketBody.md) | | |
|
|
1667
|
+
|
|
1668
|
+
### Return type
|
|
1669
|
+
|
|
1670
|
+
[**CreateTicket200Response**](CreateTicket200Response.md)
|
|
1671
|
+
|
|
1672
|
+
### Authorization
|
|
1673
|
+
|
|
1674
|
+
[api_key](../README.md#api_key)
|
|
1675
|
+
|
|
1676
|
+
### HTTP request headers
|
|
1677
|
+
|
|
1678
|
+
- **Content-Type**: application/json
|
|
1679
|
+
- **Accept**: application/json
|
|
1680
|
+
|
|
1681
|
+
|
|
1529
1682
|
## create_user_badge
|
|
1530
1683
|
|
|
1531
1684
|
> <CreateUserBadge200Response> create_user_badge(tenant_id, create_user_badge_params)
|
|
@@ -5688,6 +5841,160 @@ end
|
|
|
5688
5841
|
- **Accept**: application/json
|
|
5689
5842
|
|
|
5690
5843
|
|
|
5844
|
+
## get_ticket
|
|
5845
|
+
|
|
5846
|
+
> <GetTicket200Response> get_ticket(tenant_id, id, opts)
|
|
5847
|
+
|
|
5848
|
+
|
|
5849
|
+
|
|
5850
|
+
### Examples
|
|
5851
|
+
|
|
5852
|
+
```ruby
|
|
5853
|
+
require 'time'
|
|
5854
|
+
require 'fastcomments-client'
|
|
5855
|
+
# setup authorization
|
|
5856
|
+
FastCommentsClient.configure do |config|
|
|
5857
|
+
# Configure API key authorization: api_key
|
|
5858
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
5859
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5860
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
5861
|
+
end
|
|
5862
|
+
|
|
5863
|
+
api_instance = FastCommentsClient::DefaultApi.new
|
|
5864
|
+
tenant_id = 'tenant_id_example' # String |
|
|
5865
|
+
id = 'id_example' # String |
|
|
5866
|
+
opts = {
|
|
5867
|
+
user_id: 'user_id_example' # String |
|
|
5868
|
+
}
|
|
5869
|
+
|
|
5870
|
+
begin
|
|
5871
|
+
|
|
5872
|
+
result = api_instance.get_ticket(tenant_id, id, opts)
|
|
5873
|
+
p result
|
|
5874
|
+
rescue FastCommentsClient::ApiError => e
|
|
5875
|
+
puts "Error when calling DefaultApi->get_ticket: #{e}"
|
|
5876
|
+
end
|
|
5877
|
+
```
|
|
5878
|
+
|
|
5879
|
+
#### Using the get_ticket_with_http_info variant
|
|
5880
|
+
|
|
5881
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5882
|
+
|
|
5883
|
+
> <Array(<GetTicket200Response>, Integer, Hash)> get_ticket_with_http_info(tenant_id, id, opts)
|
|
5884
|
+
|
|
5885
|
+
```ruby
|
|
5886
|
+
begin
|
|
5887
|
+
|
|
5888
|
+
data, status_code, headers = api_instance.get_ticket_with_http_info(tenant_id, id, opts)
|
|
5889
|
+
p status_code # => 2xx
|
|
5890
|
+
p headers # => { ... }
|
|
5891
|
+
p data # => <GetTicket200Response>
|
|
5892
|
+
rescue FastCommentsClient::ApiError => e
|
|
5893
|
+
puts "Error when calling DefaultApi->get_ticket_with_http_info: #{e}"
|
|
5894
|
+
end
|
|
5895
|
+
```
|
|
5896
|
+
|
|
5897
|
+
### Parameters
|
|
5898
|
+
|
|
5899
|
+
| Name | Type | Description | Notes |
|
|
5900
|
+
| ---- | ---- | ----------- | ----- |
|
|
5901
|
+
| **tenant_id** | **String** | | |
|
|
5902
|
+
| **id** | **String** | | |
|
|
5903
|
+
| **user_id** | **String** | | [optional] |
|
|
5904
|
+
|
|
5905
|
+
### Return type
|
|
5906
|
+
|
|
5907
|
+
[**GetTicket200Response**](GetTicket200Response.md)
|
|
5908
|
+
|
|
5909
|
+
### Authorization
|
|
5910
|
+
|
|
5911
|
+
[api_key](../README.md#api_key)
|
|
5912
|
+
|
|
5913
|
+
### HTTP request headers
|
|
5914
|
+
|
|
5915
|
+
- **Content-Type**: Not defined
|
|
5916
|
+
- **Accept**: application/json
|
|
5917
|
+
|
|
5918
|
+
|
|
5919
|
+
## get_tickets
|
|
5920
|
+
|
|
5921
|
+
> <GetTickets200Response> get_tickets(tenant_id, opts)
|
|
5922
|
+
|
|
5923
|
+
|
|
5924
|
+
|
|
5925
|
+
### Examples
|
|
5926
|
+
|
|
5927
|
+
```ruby
|
|
5928
|
+
require 'time'
|
|
5929
|
+
require 'fastcomments-client'
|
|
5930
|
+
# setup authorization
|
|
5931
|
+
FastCommentsClient.configure do |config|
|
|
5932
|
+
# Configure API key authorization: api_key
|
|
5933
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
5934
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5935
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
5936
|
+
end
|
|
5937
|
+
|
|
5938
|
+
api_instance = FastCommentsClient::DefaultApi.new
|
|
5939
|
+
tenant_id = 'tenant_id_example' # String |
|
|
5940
|
+
opts = {
|
|
5941
|
+
user_id: 'user_id_example', # String |
|
|
5942
|
+
state: 1.2, # Float |
|
|
5943
|
+
skip: 1.2, # Float |
|
|
5944
|
+
limit: 1.2 # Float |
|
|
5945
|
+
}
|
|
5946
|
+
|
|
5947
|
+
begin
|
|
5948
|
+
|
|
5949
|
+
result = api_instance.get_tickets(tenant_id, opts)
|
|
5950
|
+
p result
|
|
5951
|
+
rescue FastCommentsClient::ApiError => e
|
|
5952
|
+
puts "Error when calling DefaultApi->get_tickets: #{e}"
|
|
5953
|
+
end
|
|
5954
|
+
```
|
|
5955
|
+
|
|
5956
|
+
#### Using the get_tickets_with_http_info variant
|
|
5957
|
+
|
|
5958
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5959
|
+
|
|
5960
|
+
> <Array(<GetTickets200Response>, Integer, Hash)> get_tickets_with_http_info(tenant_id, opts)
|
|
5961
|
+
|
|
5962
|
+
```ruby
|
|
5963
|
+
begin
|
|
5964
|
+
|
|
5965
|
+
data, status_code, headers = api_instance.get_tickets_with_http_info(tenant_id, opts)
|
|
5966
|
+
p status_code # => 2xx
|
|
5967
|
+
p headers # => { ... }
|
|
5968
|
+
p data # => <GetTickets200Response>
|
|
5969
|
+
rescue FastCommentsClient::ApiError => e
|
|
5970
|
+
puts "Error when calling DefaultApi->get_tickets_with_http_info: #{e}"
|
|
5971
|
+
end
|
|
5972
|
+
```
|
|
5973
|
+
|
|
5974
|
+
### Parameters
|
|
5975
|
+
|
|
5976
|
+
| Name | Type | Description | Notes |
|
|
5977
|
+
| ---- | ---- | ----------- | ----- |
|
|
5978
|
+
| **tenant_id** | **String** | | |
|
|
5979
|
+
| **user_id** | **String** | | [optional] |
|
|
5980
|
+
| **state** | **Float** | | [optional] |
|
|
5981
|
+
| **skip** | **Float** | | [optional] |
|
|
5982
|
+
| **limit** | **Float** | | [optional] |
|
|
5983
|
+
|
|
5984
|
+
### Return type
|
|
5985
|
+
|
|
5986
|
+
[**GetTickets200Response**](GetTickets200Response.md)
|
|
5987
|
+
|
|
5988
|
+
### Authorization
|
|
5989
|
+
|
|
5990
|
+
[api_key](../README.md#api_key)
|
|
5991
|
+
|
|
5992
|
+
### HTTP request headers
|
|
5993
|
+
|
|
5994
|
+
- **Content-Type**: Not defined
|
|
5995
|
+
- **Accept**: application/json
|
|
5996
|
+
|
|
5997
|
+
|
|
5691
5998
|
## get_user
|
|
5692
5999
|
|
|
5693
6000
|
> <GetUser200Response> get_user(tenant_id, id)
|
|
@@ -7942,6 +8249,83 @@ end
|
|
|
7942
8249
|
- **Accept**: application/json
|
|
7943
8250
|
|
|
7944
8251
|
|
|
8252
|
+
## update_subscription
|
|
8253
|
+
|
|
8254
|
+
> <UpdateSubscriptionAPIResponse> update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
|
|
8255
|
+
|
|
8256
|
+
|
|
8257
|
+
|
|
8258
|
+
### Examples
|
|
8259
|
+
|
|
8260
|
+
```ruby
|
|
8261
|
+
require 'time'
|
|
8262
|
+
require 'fastcomments-client'
|
|
8263
|
+
# setup authorization
|
|
8264
|
+
FastCommentsClient.configure do |config|
|
|
8265
|
+
# Configure API key authorization: api_key
|
|
8266
|
+
config.api_key['x-api-key'] = 'YOUR API KEY'
|
|
8267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8268
|
+
# config.api_key_prefix['x-api-key'] = 'Bearer'
|
|
8269
|
+
end
|
|
8270
|
+
|
|
8271
|
+
api_instance = FastCommentsClient::DefaultApi.new
|
|
8272
|
+
tenant_id = 'tenant_id_example' # String |
|
|
8273
|
+
id = 'id_example' # String |
|
|
8274
|
+
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
|
|
8275
|
+
opts = {
|
|
8276
|
+
user_id: 'user_id_example' # String |
|
|
8277
|
+
}
|
|
8278
|
+
|
|
8279
|
+
begin
|
|
8280
|
+
|
|
8281
|
+
result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
|
|
8282
|
+
p result
|
|
8283
|
+
rescue FastCommentsClient::ApiError => e
|
|
8284
|
+
puts "Error when calling DefaultApi->update_subscription: #{e}"
|
|
8285
|
+
end
|
|
8286
|
+
```
|
|
8287
|
+
|
|
8288
|
+
#### Using the update_subscription_with_http_info variant
|
|
8289
|
+
|
|
8290
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8291
|
+
|
|
8292
|
+
> <Array(<UpdateSubscriptionAPIResponse>, Integer, Hash)> update_subscription_with_http_info(tenant_id, id, update_api_user_subscription_data, opts)
|
|
8293
|
+
|
|
8294
|
+
```ruby
|
|
8295
|
+
begin
|
|
8296
|
+
|
|
8297
|
+
data, status_code, headers = api_instance.update_subscription_with_http_info(tenant_id, id, update_api_user_subscription_data, opts)
|
|
8298
|
+
p status_code # => 2xx
|
|
8299
|
+
p headers # => { ... }
|
|
8300
|
+
p data # => <UpdateSubscriptionAPIResponse>
|
|
8301
|
+
rescue FastCommentsClient::ApiError => e
|
|
8302
|
+
puts "Error when calling DefaultApi->update_subscription_with_http_info: #{e}"
|
|
8303
|
+
end
|
|
8304
|
+
```
|
|
8305
|
+
|
|
8306
|
+
### Parameters
|
|
8307
|
+
|
|
8308
|
+
| Name | Type | Description | Notes |
|
|
8309
|
+
| ---- | ---- | ----------- | ----- |
|
|
8310
|
+
| **tenant_id** | **String** | | |
|
|
8311
|
+
| **id** | **String** | | |
|
|
8312
|
+
| **update_api_user_subscription_data** | [**UpdateAPIUserSubscriptionData**](UpdateAPIUserSubscriptionData.md) | | |
|
|
8313
|
+
| **user_id** | **String** | | [optional] |
|
|
8314
|
+
|
|
8315
|
+
### Return type
|
|
8316
|
+
|
|
8317
|
+
[**UpdateSubscriptionAPIResponse**](UpdateSubscriptionAPIResponse.md)
|
|
8318
|
+
|
|
8319
|
+
### Authorization
|
|
8320
|
+
|
|
8321
|
+
[api_key](../README.md#api_key)
|
|
8322
|
+
|
|
8323
|
+
### HTTP request headers
|
|
8324
|
+
|
|
8325
|
+
- **Content-Type**: application/json
|
|
8326
|
+
- **Accept**: application/json
|
|
8327
|
+
|
|
8328
|
+
|
|
7945
8329
|
## update_tenant
|
|
7946
8330
|
|
|
7947
8331
|
> <FlagCommentPublic200Response> update_tenant(tenant_id, id, update_tenant_body)
|
data/client/docs/FComment.md
CHANGED
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
| **view_count** | **Integer** | | [optional] |
|
|
76
76
|
| **requires_verification** | **Boolean** | | [optional] |
|
|
77
77
|
| **edit_key** | **String** | | [optional] |
|
|
78
|
+
| **tos_accepted_at** | **Time** | | [optional] |
|
|
78
79
|
|
|
79
80
|
## Example
|
|
80
81
|
|
|
@@ -152,7 +153,8 @@ instance = FastCommentsClient::FComment.new(
|
|
|
152
153
|
group_ids: null,
|
|
153
154
|
view_count: null,
|
|
154
155
|
requires_verification: null,
|
|
155
|
-
edit_key: null
|
|
156
|
+
edit_key: null,
|
|
157
|
+
tos_accepted_at: null
|
|
156
158
|
)
|
|
157
159
|
```
|
|
158
160
|
|
data/client/docs/FCommentMeta.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **wp_id** | **String** | | [optional] |
|
|
7
8
|
| **wp_user_id** | **String** | | [optional] |
|
|
8
9
|
| **wp_post_id** | **String** | | [optional] |
|
|
9
10
|
|
|
@@ -13,6 +14,7 @@
|
|
|
13
14
|
require 'fastcomments-client'
|
|
14
15
|
|
|
15
16
|
instance = FastCommentsClient::FCommentMeta.new(
|
|
17
|
+
wp_id: null,
|
|
16
18
|
wp_user_id: null,
|
|
17
19
|
wp_post_id: null
|
|
18
20
|
)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# FastCommentsClient::GetTicket200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**APIStatus**](APIStatus.md) | | |
|
|
8
|
+
| **ticket** | [**APITicketDetail**](APITicketDetail.md) | | |
|
|
9
|
+
| **available_states** | **Array<Float>** | | |
|
|
10
|
+
| **reason** | **String** | | |
|
|
11
|
+
| **code** | **String** | | |
|
|
12
|
+
| **secondary_code** | **String** | | [optional] |
|
|
13
|
+
| **banned_until** | **Integer** | | [optional] |
|
|
14
|
+
| **max_character_length** | **Integer** | | [optional] |
|
|
15
|
+
| **translated_error** | **String** | | [optional] |
|
|
16
|
+
| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'fastcomments-client'
|
|
22
|
+
|
|
23
|
+
instance = FastCommentsClient::GetTicket200Response.new(
|
|
24
|
+
status: null,
|
|
25
|
+
ticket: null,
|
|
26
|
+
available_states: null,
|
|
27
|
+
reason: null,
|
|
28
|
+
code: null,
|
|
29
|
+
secondary_code: null,
|
|
30
|
+
banned_until: null,
|
|
31
|
+
max_character_length: null,
|
|
32
|
+
translated_error: null,
|
|
33
|
+
custom_config: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FastCommentsClient::GetTicketResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**APIStatus**](APIStatus.md) | | |
|
|
8
|
+
| **ticket** | [**APITicketDetail**](APITicketDetail.md) | | |
|
|
9
|
+
| **available_states** | **Array<Float>** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'fastcomments-client'
|
|
15
|
+
|
|
16
|
+
instance = FastCommentsClient::GetTicketResponse.new(
|
|
17
|
+
status: null,
|
|
18
|
+
ticket: null,
|
|
19
|
+
available_states: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# FastCommentsClient::GetTickets200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**APIStatus**](APIStatus.md) | | |
|
|
8
|
+
| **tickets** | [**Array<APITicket>**](APITicket.md) | | |
|
|
9
|
+
| **reason** | **String** | | |
|
|
10
|
+
| **code** | **String** | | |
|
|
11
|
+
| **secondary_code** | **String** | | [optional] |
|
|
12
|
+
| **banned_until** | **Integer** | | [optional] |
|
|
13
|
+
| **max_character_length** | **Integer** | | [optional] |
|
|
14
|
+
| **translated_error** | **String** | | [optional] |
|
|
15
|
+
| **custom_config** | [**CustomConfigParameters**](CustomConfigParameters.md) | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'fastcomments-client'
|
|
21
|
+
|
|
22
|
+
instance = FastCommentsClient::GetTickets200Response.new(
|
|
23
|
+
status: null,
|
|
24
|
+
tickets: null,
|
|
25
|
+
reason: null,
|
|
26
|
+
code: null,
|
|
27
|
+
secondary_code: null,
|
|
28
|
+
banned_until: null,
|
|
29
|
+
max_character_length: null,
|
|
30
|
+
translated_error: null,
|
|
31
|
+
custom_config: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FastCommentsClient::GetTicketsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | [**APIStatus**](APIStatus.md) | | |
|
|
8
|
+
| **tickets** | [**Array<APITicket>**](APITicket.md) | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'fastcomments-client'
|
|
14
|
+
|
|
15
|
+
instance = FastCommentsClient::GetTicketsResponse.new(
|
|
16
|
+
status: null,
|
|
17
|
+
tickets: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# FastCommentsClient::HeaderAccountNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | | |
|
|
8
|
+
| **title** | **String** | | |
|
|
9
|
+
| **message** | **String** | | |
|
|
10
|
+
| **messages_by_locale** | **Hash<String, String>** | Construct a type with a set of properties K of type T | |
|
|
11
|
+
| **dates** | **Hash<String, String>** | Construct a type with a set of properties K of type T | |
|
|
12
|
+
| **severity** | **String** | | |
|
|
13
|
+
| **link_url** | **String** | | |
|
|
14
|
+
| **link_text** | **String** | | |
|
|
15
|
+
| **created_at** | **Time** | | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'fastcomments-client'
|
|
21
|
+
|
|
22
|
+
instance = FastCommentsClient::HeaderAccountNotification.new(
|
|
23
|
+
_id: null,
|
|
24
|
+
title: null,
|
|
25
|
+
message: null,
|
|
26
|
+
messages_by_locale: null,
|
|
27
|
+
dates: null,
|
|
28
|
+
severity: null,
|
|
29
|
+
link_url: null,
|
|
30
|
+
link_text: null,
|
|
31
|
+
created_at: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
data/client/docs/HeaderState.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **user_id** | **String** | | |
|
|
10
10
|
| **user_id_ws** | **String** | | |
|
|
11
11
|
| **notification_counts** | [**Array<NotificationAndCount>**](NotificationAndCount.md) | | |
|
|
12
|
+
| **account_notifications** | [**Array<HeaderAccountNotification>**](HeaderAccountNotification.md) | | |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = FastCommentsClient::HeaderState.new(
|
|
|
20
21
|
notification_type: null,
|
|
21
22
|
user_id: null,
|
|
22
23
|
user_id_ws: null,
|
|
23
|
-
notification_counts: null
|
|
24
|
+
notification_counts: null,
|
|
25
|
+
account_notifications: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# FastCommentsClient::MentionAutoCompleteMode
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'fastcomments-client'
|
|
12
|
+
|
|
13
|
+
instance = FastCommentsClient::MentionAutoCompleteMode.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/client/docs/Moderator.md
CHANGED
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
| **verification_id** | **String** | | |
|
|
23
23
|
| **created_at** | **Time** | | |
|
|
24
24
|
| **moderation_group_ids** | **Array<String>** | | |
|
|
25
|
+
| **is_email_suppressed** | **Boolean** | | [optional] |
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -46,7 +47,8 @@ instance = FastCommentsClient::Moderator.new(
|
|
|
46
47
|
un_flagged_count: null,
|
|
47
48
|
verification_id: null,
|
|
48
49
|
created_at: null,
|
|
49
|
-
moderation_group_ids: null
|
|
50
|
+
moderation_group_ids: null,
|
|
51
|
+
is_email_suppressed: null
|
|
50
52
|
)
|
|
51
53
|
```
|
|
52
54
|
|
data/client/docs/PublicApi.md
CHANGED
|
@@ -1817,7 +1817,8 @@ url_id = 'url_id_example' # String |
|
|
|
1817
1817
|
opts = {
|
|
1818
1818
|
username_starts_with: 'username_starts_with_example', # String |
|
|
1819
1819
|
mention_group_ids: ['inner_example'], # Array<String> |
|
|
1820
|
-
sso: 'sso_example' # String |
|
|
1820
|
+
sso: 'sso_example', # String |
|
|
1821
|
+
search_section: 'fast' # String |
|
|
1821
1822
|
}
|
|
1822
1823
|
|
|
1823
1824
|
begin
|
|
@@ -1856,6 +1857,7 @@ end
|
|
|
1856
1857
|
| **username_starts_with** | **String** | | [optional] |
|
|
1857
1858
|
| **mention_group_ids** | [**Array<String>**](String.md) | | [optional] |
|
|
1858
1859
|
| **sso** | **String** | | [optional] |
|
|
1860
|
+
| **search_section** | **String** | | [optional] |
|
|
1859
1861
|
|
|
1860
1862
|
### Return type
|
|
1861
1863
|
|