Interface ViewService
-
- All Implemented Interfaces:
public interface ViewService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceViewService.WithRawResponseA view of ViewService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract ViewService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. Viewcreate(ViewCreateParams params)Create a new view. abstract Viewcreate(ViewCreateParams params, RequestOptions requestOptions)Viewretrieve(ViewRetrieveParams params)Get a view object by its id abstract Viewretrieve(ViewRetrieveParams params, RequestOptions requestOptions)Viewupdate(ViewUpdateParams params)Partially update a view object. abstract Viewupdate(ViewUpdateParams params, RequestOptions requestOptions)ViewListPagelist(ViewListParams params)List out all views. abstract ViewListPagelist(ViewListParams params, RequestOptions requestOptions)Viewdelete(ViewDeleteParams params)Delete a view object by its id abstract Viewdelete(ViewDeleteParams params, RequestOptions requestOptions)Viewreplace(ViewReplaceParams params)Create or replace view. abstract Viewreplace(ViewReplaceParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract ViewService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
View create(ViewCreateParams params)
Create a new view. If there is an existing view with the same name as the one specified in the request, will return the existing view unmodified
-
create
abstract View create(ViewCreateParams params, RequestOptions requestOptions)
-
retrieve
View retrieve(ViewRetrieveParams params)
Get a view object by its id
-
retrieve
abstract View retrieve(ViewRetrieveParams params, RequestOptions requestOptions)
-
update
View update(ViewUpdateParams params)
Partially update a view object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
update
abstract View update(ViewUpdateParams params, RequestOptions requestOptions)
-
list
ViewListPage list(ViewListParams params)
List out all views. The views are sorted by creation date, with the most recently-created views coming first
-
list
abstract ViewListPage list(ViewListParams params, RequestOptions requestOptions)
-
delete
View delete(ViewDeleteParams params)
Delete a view object by its id
-
delete
abstract View delete(ViewDeleteParams params, RequestOptions requestOptions)
-
replace
View replace(ViewReplaceParams params)
Create or replace view. If there is an existing view with the same name as the one specified in the request, will replace the existing view with the provided fields
-
replace
abstract View replace(ViewReplaceParams params, RequestOptions requestOptions)
-
-
-
-