Documentation
¶
Index ¶
- type Client
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) SubmitReport(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, *SubmitReportBadRequest, *SubmitReportConflict, ...)deprecated
- func (a *Client) SubmitReportShort(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, error)
- type ClientService
- type SubmitReportBadRequest
- type SubmitReportConflict
- type SubmitReportCreated
- type SubmitReportInternalServerError
- type SubmitReportParams
- func (o *SubmitReportParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *SubmitReportParams) SetBody(body *reportingclientmodels.RestapiSubmitReportRequest)
- func (o *SubmitReportParams) SetContext(ctx context.Context)
- func (o *SubmitReportParams) SetFlightId(flightId string)
- func (o *SubmitReportParams) SetHTTPClient(client *http.Client)
- func (o *SubmitReportParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *SubmitReportParams) SetNamespace(namespace string)
- func (o *SubmitReportParams) SetTimeout(timeout time.Duration)
- func (o *SubmitReportParams) WithBody(body *reportingclientmodels.RestapiSubmitReportRequest) *SubmitReportParams
- func (o *SubmitReportParams) WithContext(ctx context.Context) *SubmitReportParams
- func (o *SubmitReportParams) WithHTTPClient(client *http.Client) *SubmitReportParams
- func (o *SubmitReportParams) WithNamespace(namespace string) *SubmitReportParams
- func (o *SubmitReportParams) WithTimeout(timeout time.Duration) *SubmitReportParams
- func (o *SubmitReportParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SubmitReportReader
- type SubmitReportTooManyRequests
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for public reports API
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) SubmitReport
deprecated
func (a *Client) SubmitReport(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, *SubmitReportBadRequest, *SubmitReportConflict, *SubmitReportTooManyRequests, *SubmitReportInternalServerError, error)
Deprecated: 2022-08-10 - Use SubmitReportShort instead.
SubmitReport submit a report User need to be authenticated to access this endpoint. Submit a report and will return ticket for reported object. New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
User can only submit report once for each different user / object reported in the same OPEN ticket. Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title' Supported category: - UGC - USER - CHAT - EXTENSION
func (*Client) SubmitReportShort ¶
func (a *Client) SubmitReportShort(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, error)
SubmitReportShort submit a report User need to be authenticated to access this endpoint. Submit a report and will return ticket for reported object. New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
User can only submit report once for each different user / object reported in the same OPEN ticket. Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title' Supported category: - UGC - USER - CHAT - EXTENSION
type ClientService ¶
type ClientService interface {
SubmitReport(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, *SubmitReportBadRequest, *SubmitReportConflict, *SubmitReportTooManyRequests, *SubmitReportInternalServerError, error)
SubmitReportShort(params *SubmitReportParams, authInfo runtime.ClientAuthInfoWriter) (*SubmitReportCreated, error)
SetTransport(transport runtime.ClientTransport)
}
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new public reports API client.
type SubmitReportBadRequest ¶
type SubmitReportBadRequest struct {
Payload *reportingclientmodels.RestapiErrorResponse
}
SubmitReportBadRequest handles this case with default header values.
func NewSubmitReportBadRequest ¶
func NewSubmitReportBadRequest() *SubmitReportBadRequest
NewSubmitReportBadRequest creates a SubmitReportBadRequest with default headers values
func (*SubmitReportBadRequest) Error ¶
func (o *SubmitReportBadRequest) Error() string
func (*SubmitReportBadRequest) GetPayload ¶
func (o *SubmitReportBadRequest) GetPayload() *reportingclientmodels.RestapiErrorResponse
func (*SubmitReportBadRequest) ToJSONString ¶
func (o *SubmitReportBadRequest) ToJSONString() string
type SubmitReportConflict ¶
type SubmitReportConflict struct {
Payload *reportingclientmodels.RestapiErrorResponse
}
SubmitReportConflict handles this case with default header values.
func NewSubmitReportConflict ¶
func NewSubmitReportConflict() *SubmitReportConflict
NewSubmitReportConflict creates a SubmitReportConflict with default headers values
func (*SubmitReportConflict) Error ¶
func (o *SubmitReportConflict) Error() string
func (*SubmitReportConflict) GetPayload ¶
func (o *SubmitReportConflict) GetPayload() *reportingclientmodels.RestapiErrorResponse
func (*SubmitReportConflict) ToJSONString ¶
func (o *SubmitReportConflict) ToJSONString() string
type SubmitReportCreated ¶
type SubmitReportCreated struct {
Payload *reportingclientmodels.RestapiSubmitReportResponse
}
SubmitReportCreated handles this case with default header values.
func NewSubmitReportCreated ¶
func NewSubmitReportCreated() *SubmitReportCreated
NewSubmitReportCreated creates a SubmitReportCreated with default headers values
func (*SubmitReportCreated) Error ¶
func (o *SubmitReportCreated) Error() string
func (*SubmitReportCreated) GetPayload ¶
func (o *SubmitReportCreated) GetPayload() *reportingclientmodels.RestapiSubmitReportResponse
func (*SubmitReportCreated) ToJSONString ¶
func (o *SubmitReportCreated) ToJSONString() string
type SubmitReportInternalServerError ¶
type SubmitReportInternalServerError struct {
Payload *reportingclientmodels.RestapiErrorResponse
}
SubmitReportInternalServerError handles this case with default header values.
func NewSubmitReportInternalServerError ¶
func NewSubmitReportInternalServerError() *SubmitReportInternalServerError
NewSubmitReportInternalServerError creates a SubmitReportInternalServerError with default headers values
func (*SubmitReportInternalServerError) Error ¶
func (o *SubmitReportInternalServerError) Error() string
func (*SubmitReportInternalServerError) GetPayload ¶
func (o *SubmitReportInternalServerError) GetPayload() *reportingclientmodels.RestapiErrorResponse
func (*SubmitReportInternalServerError) ToJSONString ¶
func (o *SubmitReportInternalServerError) ToJSONString() string
type SubmitReportParams ¶
type SubmitReportParams struct {
/*RetryPolicy*/
RetryPolicy *utils.Retry
/*Body*/
Body *reportingclientmodels.RestapiSubmitReportRequest
/*Namespace*/
Namespace string
AuthInfoWriter runtime.ClientAuthInfoWriter
Context context.Context
HTTPClient *http.Client
// XFlightId is an optional parameter from this SDK
XFlightId *string
// contains filtered or unexported fields
}
SubmitReportParams contains all the parameters to send to the API endpoint for the submit report operation typically these are written to a http.Request
func NewSubmitReportParams ¶
func NewSubmitReportParams() *SubmitReportParams
NewSubmitReportParams creates a new SubmitReportParams object with the default values initialized.
func NewSubmitReportParamsWithContext ¶
func NewSubmitReportParamsWithContext(ctx context.Context) *SubmitReportParams
NewSubmitReportParamsWithContext creates a new SubmitReportParams object with the default values initialized, and the ability to set a context for a request
func NewSubmitReportParamsWithHTTPClient ¶
func NewSubmitReportParamsWithHTTPClient(client *http.Client) *SubmitReportParams
NewSubmitReportParamsWithHTTPClient creates a new SubmitReportParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSubmitReportParamsWithTimeout ¶
func NewSubmitReportParamsWithTimeout(timeout time.Duration) *SubmitReportParams
NewSubmitReportParamsWithTimeout creates a new SubmitReportParams object with the default values initialized, and the ability to set a timeout on a request
func (*SubmitReportParams) SetAuthInfoWriter ¶
func (o *SubmitReportParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the submit report params
func (*SubmitReportParams) SetBody ¶
func (o *SubmitReportParams) SetBody(body *reportingclientmodels.RestapiSubmitReportRequest)
SetBody adds the body to the submit report params
func (*SubmitReportParams) SetContext ¶
func (o *SubmitReportParams) SetContext(ctx context.Context)
SetContext adds the context to the submit report params
func (*SubmitReportParams) SetFlightId ¶ added in v0.63.0
func (o *SubmitReportParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*SubmitReportParams) SetHTTPClient ¶
func (o *SubmitReportParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the submit report params
func (*SubmitReportParams) SetHTTPClientTransport ¶
func (o *SubmitReportParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the submit report params
func (*SubmitReportParams) SetNamespace ¶
func (o *SubmitReportParams) SetNamespace(namespace string)
SetNamespace adds the namespace to the submit report params
func (*SubmitReportParams) SetTimeout ¶
func (o *SubmitReportParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the submit report params
func (*SubmitReportParams) WithBody ¶
func (o *SubmitReportParams) WithBody(body *reportingclientmodels.RestapiSubmitReportRequest) *SubmitReportParams
WithBody adds the body to the submit report params
func (*SubmitReportParams) WithContext ¶
func (o *SubmitReportParams) WithContext(ctx context.Context) *SubmitReportParams
WithContext adds the context to the submit report params
func (*SubmitReportParams) WithHTTPClient ¶
func (o *SubmitReportParams) WithHTTPClient(client *http.Client) *SubmitReportParams
WithHTTPClient adds the HTTPClient to the submit report params
func (*SubmitReportParams) WithNamespace ¶
func (o *SubmitReportParams) WithNamespace(namespace string) *SubmitReportParams
WithNamespace adds the namespace to the submit report params
func (*SubmitReportParams) WithTimeout ¶
func (o *SubmitReportParams) WithTimeout(timeout time.Duration) *SubmitReportParams
WithTimeout adds the timeout to the submit report params
func (*SubmitReportParams) WriteToRequest ¶
func (o *SubmitReportParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SubmitReportReader ¶
type SubmitReportReader struct {
// contains filtered or unexported fields
}
SubmitReportReader is a Reader for the SubmitReport structure.
func (*SubmitReportReader) ReadResponse ¶
func (o *SubmitReportReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type SubmitReportTooManyRequests ¶
type SubmitReportTooManyRequests struct {
Payload *reportingclientmodels.RestapiErrorResponse
}
SubmitReportTooManyRequests handles this case with default header values.
func NewSubmitReportTooManyRequests ¶
func NewSubmitReportTooManyRequests() *SubmitReportTooManyRequests
NewSubmitReportTooManyRequests creates a SubmitReportTooManyRequests with default headers values
func (*SubmitReportTooManyRequests) Error ¶
func (o *SubmitReportTooManyRequests) Error() string
func (*SubmitReportTooManyRequests) GetPayload ¶
func (o *SubmitReportTooManyRequests) GetPayload() *reportingclientmodels.RestapiErrorResponse
func (*SubmitReportTooManyRequests) ToJSONString ¶
func (o *SubmitReportTooManyRequests) ToJSONString() string
Source Files