generatedfcm

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package generatedfcm provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCheckInFCMClientRequestWithBody 

func NewCheckInFCMClientRequestWithBody(server string, params *CheckInFCMClientParams, contentType string, body io.Reader) (*http.Request, error)

NewCheckInFCMClientRequestWithBody constructs an http.Request for the CheckInFCMClient method, with any body, and a specified content type

func NewCreateFCMInstallationRequest 

func NewCreateFCMInstallationRequest(server string, params *CreateFCMInstallationParams, body CreateFCMInstallationJSONRequestBody) (*http.Request, error)

NewCreateFCMInstallationRequest calls the generic CreateFCMInstallation builder with application/json body

func NewCreateFCMInstallationRequestWithBody 

func NewCreateFCMInstallationRequestWithBody(server string, params *CreateFCMInstallationParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateFCMInstallationRequestWithBody constructs an http.Request for the CreateFCMInstallation method, with any body, and a specified content type

func NewRegisterFCMClientRequestWithBody 

func NewRegisterFCMClientRequestWithBody(server string, params *RegisterFCMClientParams, contentType string, body io.Reader) (*http.Request, error)

NewRegisterFCMClientRequestWithBody constructs an http.Request for the RegisterFCMClient method, with any body, and a specified content type

func NewRegisterFCMClientRequestWithFormdataBody 

func NewRegisterFCMClientRequestWithFormdataBody(server string, params *RegisterFCMClientParams, body RegisterFCMClientFormdataRequestBody) (*http.Request, error)

NewRegisterFCMClientRequestWithFormdataBody calls the generic RegisterFCMClient builder with application/x-www-form-urlencoded body

func NewRegisterFCMInstallationRequest 

func NewRegisterFCMInstallationRequest(server string, params *RegisterFCMInstallationParams, body RegisterFCMInstallationJSONRequestBody) (*http.Request, error)

NewRegisterFCMInstallationRequest calls the generic RegisterFCMInstallation builder with application/json body

func NewRegisterFCMInstallationRequestWithBody 

func NewRegisterFCMInstallationRequestWithBody(server string, params *RegisterFCMInstallationParams, contentType string, body io.Reader) (*http.Request, error)

NewRegisterFCMInstallationRequestWithBody constructs an http.Request for the RegisterFCMInstallation method, with any body, and a specified content type

Types

type AndroidCheckinRequestWire 

type AndroidCheckinRequestWire = openapi_types.File

AndroidCheckinRequestWire Protobuf wire encoding of checkin_proto.AndroidCheckinRequest in the pinned checkin.proto files.

type AndroidCheckinResponseWire 

type AndroidCheckinResponseWire = openapi_types.File

AndroidCheckinResponseWire Protobuf wire encoding of checkin_proto.AndroidCheckinResponse in the pinned checkin.proto files.

type CheckInFCMClientParams 

type CheckInFCMClientParams struct {
	ContentType CheckInFCMClientParamsContentType `json:"Content-Type"`
}

CheckInFCMClientParams defines parameters for CheckInFCMClient.

type CheckInFCMClientParamsContentType 

type CheckInFCMClientParamsContentType string

CheckInFCMClientParamsContentType defines parameters for CheckInFCMClient. 

const (
	CheckInFCMClientParamsContentTypeApplicationxProtobuf CheckInFCMClientParamsContentType = "application/x-protobuf"
)

Defines values for CheckInFCMClientParamsContentType.

func (CheckInFCMClientParamsContentType) Valid 

func (e CheckInFCMClientParamsContentType) Valid() bool

Valid indicates whether the value is a known member of the CheckInFCMClientParamsContentType enum.

type CheckInFCMClientResponse 

type CheckInFCMClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseCheckInFCMClientResponse 

func ParseCheckInFCMClientResponse(rsp *http.Response) (*CheckInFCMClientResponse, error)

ParseCheckInFCMClientResponse parses an HTTP response from a CheckInFCMClientWithResponse call

func (CheckInFCMClientResponse) ContentType 

func (r CheckInFCMClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CheckInFCMClientResponse) GetBody 

func (r CheckInFCMClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CheckInFCMClientResponse) Status 

func (r CheckInFCMClientResponse) Status() string

Status returns HTTPResponse.Status

func (CheckInFCMClientResponse) StatusCode 

func (r CheckInFCMClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CheckInFCMClientWithBody 

func (c *Client) CheckInFCMClientWithBody(ctx context.Context, params *CheckInFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CheckInFCMClientWithBody Check in an Android or Chrome client

Sends an Android check-in protobuf and receives assigned device credentials.

Takes any type of body and a specified content type.

Corresponds with POST /checkin (the `CheckInFCMClient` operationId).

func (*Client) CreateFCMInstallation 

func (c *Client) CreateFCMInstallation(ctx context.Context, params *CreateFCMInstallationParams, body CreateFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateFCMInstallation Create a Firebase installation

Creates an installation identity used to authorize FCM registration.

Takes a body of the `application/json` content type.

Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).

func (*Client) CreateFCMInstallationWithBody 

func (c *Client) CreateFCMInstallationWithBody(ctx context.Context, params *CreateFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateFCMInstallationWithBody Create a Firebase installation

Creates an installation identity used to authorize FCM registration.

Takes any type of body and a specified content type.

Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).

func (*Client) RegisterFCMClientWithBody 

func (c *Client) RegisterFCMClientWithBody(ctx context.Context, params *RegisterFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterFCMClientWithBody Register a client with legacy C2DM

Exchanges the check-in device ID and security token for a registration token.

Takes any type of body and a specified content type.

Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).

func (*Client) RegisterFCMClientWithFormdataBody 

func (c *Client) RegisterFCMClientWithFormdataBody(ctx context.Context, params *RegisterFCMClientParams, body RegisterFCMClientFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterFCMClientWithFormdataBody Register a client with legacy C2DM

Exchanges the check-in device ID and security token for a registration token.

Takes a body of the `application/x-www-form-urlencoded` content type.

Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).

func (*Client) RegisterFCMInstallation 

func (c *Client) RegisterFCMInstallation(ctx context.Context, params *RegisterFCMInstallationParams, body RegisterFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterFCMInstallation Register a Firebase installation for FCM

Registers Web Push encryption material and returns an FCM token.

Takes a body of the `application/json` content type.

Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).

func (*Client) RegisterFCMInstallationWithBody 

func (c *Client) RegisterFCMInstallationWithBody(ctx context.Context, params *RegisterFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterFCMInstallationWithBody Register a Firebase installation for FCM

Registers Web Push encryption material and returns an FCM token.

Takes any type of body and a specified content type.

Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).

type ClientInterface 

type ClientInterface interface {

	// RegisterFCMClientWithBody Register a client with legacy C2DM
	//
	// Exchanges the check-in device ID and security token for a registration token.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).
	RegisterFCMClientWithBody(ctx context.Context, params *RegisterFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterFCMClientWithFormdataBody Register a client with legacy C2DM
	//
	// Exchanges the check-in device ID and security token for a registration token.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type.
	//
	// Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).
	RegisterFCMClientWithFormdataBody(ctx context.Context, params *RegisterFCMClientParams, body RegisterFCMClientFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CheckInFCMClientWithBody Check in an Android or Chrome client
	//
	// Sends an Android check-in protobuf and receives assigned device credentials.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /checkin (the `CheckInFCMClient` operationId).
	CheckInFCMClientWithBody(ctx context.Context, params *CheckInFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMInstallationWithBody Create a Firebase installation
	//
	// Creates an installation identity used to authorize FCM registration.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).
	CreateFCMInstallationWithBody(ctx context.Context, params *CreateFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFCMInstallation Create a Firebase installation
	//
	// Creates an installation identity used to authorize FCM registration.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).
	CreateFCMInstallation(ctx context.Context, params *CreateFCMInstallationParams, body CreateFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterFCMInstallationWithBody Register a Firebase installation for FCM
	//
	// Registers Web Push encryption material and returns an FCM token.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).
	RegisterFCMInstallationWithBody(ctx context.Context, params *RegisterFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterFCMInstallation Register a Firebase installation for FCM
	//
	// Registers Web Push encryption material and returns an FCM token.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).
	RegisterFCMInstallation(ctx context.Context, params *RegisterFCMInstallationParams, body RegisterFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CheckInFCMClientWithBodyWithResponse 

func (c *ClientWithResponses) CheckInFCMClientWithBodyWithResponse(ctx context.Context, params *CheckInFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckInFCMClientResponse, error)

CheckInFCMClientWithBodyWithResponse Check in an Android or Chrome client

Sends an Android check-in protobuf and receives assigned device credentials.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /checkin (the `CheckInFCMClient` operationId).

func (*ClientWithResponses) CreateFCMInstallationWithBodyWithResponse 

func (c *ClientWithResponses) CreateFCMInstallationWithBodyWithResponse(ctx context.Context, params *CreateFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMInstallationResponse, error)

CreateFCMInstallationWithBodyWithResponse Create a Firebase installation

Creates an installation identity used to authorize FCM registration.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).

func (*ClientWithResponses) CreateFCMInstallationWithResponse 

func (c *ClientWithResponses) CreateFCMInstallationWithResponse(ctx context.Context, params *CreateFCMInstallationParams, body CreateFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMInstallationResponse, error)

CreateFCMInstallationWithResponse Create a Firebase installation

Creates an installation identity used to authorize FCM registration.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).

func (*ClientWithResponses) RegisterFCMClientWithBodyWithResponse 

func (c *ClientWithResponses) RegisterFCMClientWithBodyWithResponse(ctx context.Context, params *RegisterFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFCMClientResponse, error)

RegisterFCMClientWithBodyWithResponse Register a client with legacy C2DM

Exchanges the check-in device ID and security token for a registration token.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).

func (*ClientWithResponses) RegisterFCMClientWithFormdataBodyWithResponse 

func (c *ClientWithResponses) RegisterFCMClientWithFormdataBodyWithResponse(ctx context.Context, params *RegisterFCMClientParams, body RegisterFCMClientFormdataRequestBody, reqEditors ...RequestEditorFn) (*RegisterFCMClientResponse, error)

RegisterFCMClientWithFormdataBodyWithResponse Register a client with legacy C2DM

Exchanges the check-in device ID and security token for a registration token.

Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).

func (*ClientWithResponses) RegisterFCMInstallationWithBodyWithResponse 

func (c *ClientWithResponses) RegisterFCMInstallationWithBodyWithResponse(ctx context.Context, params *RegisterFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFCMInstallationResponse, error)

RegisterFCMInstallationWithBodyWithResponse Register a Firebase installation for FCM

Registers Web Push encryption material and returns an FCM token.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).

func (*ClientWithResponses) RegisterFCMInstallationWithResponse 

func (c *ClientWithResponses) RegisterFCMInstallationWithResponse(ctx context.Context, params *RegisterFCMInstallationParams, body RegisterFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterFCMInstallationResponse, error)

RegisterFCMInstallationWithResponse Register a Firebase installation for FCM

Registers Web Push encryption material and returns an FCM token.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {

	// RegisterFCMClientWithBodyWithResponse Register a client with legacy C2DM
	//
	// Exchanges the check-in device ID and security token for a registration token.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).
	RegisterFCMClientWithBodyWithResponse(ctx context.Context, params *RegisterFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFCMClientResponse, error)

	// RegisterFCMClientWithFormdataBodyWithResponse Register a client with legacy C2DM
	//
	// Exchanges the check-in device ID and security token for a registration token.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /c2dm/register3 (the `RegisterFCMClient` operationId).
	RegisterFCMClientWithFormdataBodyWithResponse(ctx context.Context, params *RegisterFCMClientParams, body RegisterFCMClientFormdataRequestBody, reqEditors ...RequestEditorFn) (*RegisterFCMClientResponse, error)

	// CheckInFCMClientWithBodyWithResponse Check in an Android or Chrome client
	//
	// Sends an Android check-in protobuf and receives assigned device credentials.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /checkin (the `CheckInFCMClient` operationId).
	CheckInFCMClientWithBodyWithResponse(ctx context.Context, params *CheckInFCMClientParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckInFCMClientResponse, error)

	// CreateFCMInstallationWithBodyWithResponse Create a Firebase installation
	//
	// Creates an installation identity used to authorize FCM registration.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).
	CreateFCMInstallationWithBodyWithResponse(ctx context.Context, params *CreateFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFCMInstallationResponse, error)

	// CreateFCMInstallationWithResponse Create a Firebase installation
	//
	// Creates an installation identity used to authorize FCM registration.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/projects/ring-17770/installations (the `CreateFCMInstallation` operationId).
	CreateFCMInstallationWithResponse(ctx context.Context, params *CreateFCMInstallationParams, body CreateFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFCMInstallationResponse, error)

	// RegisterFCMInstallationWithBodyWithResponse Register a Firebase installation for FCM
	//
	// Registers Web Push encryption material and returns an FCM token.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).
	RegisterFCMInstallationWithBodyWithResponse(ctx context.Context, params *RegisterFCMInstallationParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterFCMInstallationResponse, error)

	// RegisterFCMInstallationWithResponse Register a Firebase installation for FCM
	//
	// Registers Web Push encryption material and returns an FCM token.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /v1/projects/ring-17770/registrations (the `RegisterFCMInstallation` operationId).
	RegisterFCMInstallationWithResponse(ctx context.Context, params *RegisterFCMInstallationParams, body RegisterFCMInstallationJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterFCMInstallationResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateFCMInstallationJSONRequestBody 

type CreateFCMInstallationJSONRequestBody = InstallationRequest

CreateFCMInstallationJSONRequestBody defines body for CreateFCMInstallation for application/json ContentType.

type CreateFCMInstallationParams 

type CreateFCMInstallationParams struct {
	Accept      CreateFCMInstallationParamsAccept      `json:"Accept"`
	ContentType CreateFCMInstallationParamsContentType `json:"Content-Type"`

	// XGoogApiKey Public API key configured by the pinned Ring Android client.
	XGoogApiKey CreateFCMInstallationParamsXGoogApiKey `json:"X-Goog-Api-Key"`
}

CreateFCMInstallationParams defines parameters for CreateFCMInstallation.

type CreateFCMInstallationParamsAccept 

type CreateFCMInstallationParamsAccept string

CreateFCMInstallationParamsAccept defines parameters for CreateFCMInstallation. 

const (
	CreateFCMInstallationParamsAcceptApplicationjson CreateFCMInstallationParamsAccept = "application/json"
)

Defines values for CreateFCMInstallationParamsAccept.

func (CreateFCMInstallationParamsAccept) Valid 

func (e CreateFCMInstallationParamsAccept) Valid() bool

Valid indicates whether the value is a known member of the CreateFCMInstallationParamsAccept enum.

type CreateFCMInstallationParamsContentType 

type CreateFCMInstallationParamsContentType string

CreateFCMInstallationParamsContentType defines parameters for CreateFCMInstallation. 

const (
	CreateFCMInstallationParamsContentTypeApplicationjson CreateFCMInstallationParamsContentType = "application/json"
)

Defines values for CreateFCMInstallationParamsContentType.

func (CreateFCMInstallationParamsContentType) Valid 

func (e CreateFCMInstallationParamsContentType) Valid() bool

Valid indicates whether the value is a known member of the CreateFCMInstallationParamsContentType enum.

type CreateFCMInstallationParamsXGoogApiKey 

type CreateFCMInstallationParamsXGoogApiKey string

CreateFCMInstallationParamsXGoogApiKey defines parameters for CreateFCMInstallation. 

const (
	CreateFCMInstallationParamsXGoogApiKeyAIzaSyCvHdFBmmdBBJadNyTFwBXNH5m3Bk8 CreateFCMInstallationParamsXGoogApiKey = "AIzaSyCv-hdFBmmdBBJadNy-TFwB-xN_H5m3Bk8"
)

Defines values for CreateFCMInstallationParamsXGoogApiKey.

func (CreateFCMInstallationParamsXGoogApiKey) Valid 

func (e CreateFCMInstallationParamsXGoogApiKey) Valid() bool

Valid indicates whether the value is a known member of the CreateFCMInstallationParamsXGoogApiKey enum.

type CreateFCMInstallationResponse 

type CreateFCMInstallationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *InstallationResponse
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *InstallationResponse
}

func ParseCreateFCMInstallationResponse 

func ParseCreateFCMInstallationResponse(rsp *http.Response) (*CreateFCMInstallationResponse, error)

ParseCreateFCMInstallationResponse parses an HTTP response from a CreateFCMInstallationWithResponse call

func (CreateFCMInstallationResponse) ContentType 

func (r CreateFCMInstallationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateFCMInstallationResponse) GetBody 

func (r CreateFCMInstallationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateFCMInstallationResponse) GetJSON200 

func (r CreateFCMInstallationResponse) GetJSON200() *InstallationResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CreateFCMInstallationResponse) GetJSON201 

func (r CreateFCMInstallationResponse) GetJSON201() *InstallationResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateFCMInstallationResponse) Status 

func (r CreateFCMInstallationResponse) Status() string

Status returns HTTPResponse.Status

func (CreateFCMInstallationResponse) StatusCode 

func (r CreateFCMInstallationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FCMRegistrationRequest 

type FCMRegistrationRequest struct {
	Web FCMWebRegistration `json:"web"`
}

FCMRegistrationRequest defines model for FCMRegistrationRequest.

type FCMRegistrationResponse 

type FCMRegistrationResponse struct {
	PushSet              *string                `json:"pushSet,omitempty"`
	Token                string                 `json:"token"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

FCMRegistrationResponse defines model for FCMRegistrationResponse.

func (FCMRegistrationResponse) Get 

func (a FCMRegistrationResponse) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for FCMRegistrationResponse. Returns the specified element and whether it was found

func (FCMRegistrationResponse) MarshalJSON 

func (a FCMRegistrationResponse) MarshalJSON() ([]byte, error)

Override default JSON handling for FCMRegistrationResponse to handle AdditionalProperties

func (*FCMRegistrationResponse) Set 

func (a *FCMRegistrationResponse) Set(fieldName string, value interface{})

Setter for additional properties for FCMRegistrationResponse

func (*FCMRegistrationResponse) UnmarshalJSON 

func (a *FCMRegistrationResponse) UnmarshalJSON(b []byte) error

Override default JSON handling for FCMRegistrationResponse to handle AdditionalProperties

type FCMWebRegistration 

type FCMWebRegistration struct {
	// Auth URL-safe base64 encoding of a 16-byte Web Push authentication secret.
	Auth     string `json:"auth"`
	Endpoint string `json:"endpoint"`

	// P256dh URL-safe base64 encoding of a 65-byte uncompressed P-256 public key.
	P256dh string `json:"p256dh"`
}

FCMWebRegistration defines model for FCMWebRegistration.

type GoogleAPIKey 

type GoogleAPIKey string

GoogleAPIKey defines model for GoogleAPIKey. 

const (
	GoogleAPIKeyAIzaSyCvHdFBmmdBBJadNyTFwBXNH5m3Bk8 GoogleAPIKey = "AIzaSyCv-hdFBmmdBBJadNy-TFwB-xN_H5m3Bk8"
)

Defines values for GoogleAPIKey.

func (GoogleAPIKey) Valid 

func (e GoogleAPIKey) Valid() bool

Valid indicates whether the value is a known member of the GoogleAPIKey enum.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InstallationAuthToken 

type InstallationAuthToken struct {
	ExpiresIn            *string                `json:"expiresIn,omitempty"`
	Token                string                 `json:"token"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

InstallationAuthToken defines model for InstallationAuthToken.

func (InstallationAuthToken) Get 

func (a InstallationAuthToken) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for InstallationAuthToken. Returns the specified element and whether it was found

func (InstallationAuthToken) MarshalJSON 

func (a InstallationAuthToken) MarshalJSON() ([]byte, error)

Override default JSON handling for InstallationAuthToken to handle AdditionalProperties

func (*InstallationAuthToken) Set 

func (a *InstallationAuthToken) Set(fieldName string, value interface{})

Setter for additional properties for InstallationAuthToken

func (*InstallationAuthToken) UnmarshalJSON 

func (a *InstallationAuthToken) UnmarshalJSON(b []byte) error

Override default JSON handling for InstallationAuthToken to handle AdditionalProperties

type InstallationRequest 

type InstallationRequest struct {
	AppId       InstallationRequestAppId       `json:"appId"`
	AuthVersion InstallationRequestAuthVersion `json:"authVersion"`

	// Fid Base64-encoded 17-byte FID from the pinned receiver implementation.
	Fid        string                        `json:"fid"`
	SdkVersion InstallationRequestSdkVersion `json:"sdkVersion"`
}

InstallationRequest defines model for InstallationRequest.

type InstallationRequestAppId 

type InstallationRequestAppId string

InstallationRequestAppId defines model for InstallationRequest.AppId. 

const (
	InstallationRequestAppIdN1876313859327AndroidE10ec6ddb3c81f39 InstallationRequestAppId = "1:876313859327:android:e10ec6ddb3c81f39"
)

Defines values for InstallationRequestAppId.

func (InstallationRequestAppId) Valid 

func (e InstallationRequestAppId) Valid() bool

Valid indicates whether the value is a known member of the InstallationRequestAppId enum.

type InstallationRequestAuthVersion 

type InstallationRequestAuthVersion string

InstallationRequestAuthVersion defines model for InstallationRequest.AuthVersion. 

const (
	FISV2 InstallationRequestAuthVersion = "FIS_v2"
)

Defines values for InstallationRequestAuthVersion.

func (InstallationRequestAuthVersion) Valid 

func (e InstallationRequestAuthVersion) Valid() bool

Valid indicates whether the value is a known member of the InstallationRequestAuthVersion enum.

type InstallationRequestSdkVersion 

type InstallationRequestSdkVersion string

InstallationRequestSdkVersion defines model for InstallationRequest.SdkVersion. 

const (
	W0617 InstallationRequestSdkVersion = "w:0.6.17"
)

Defines values for InstallationRequestSdkVersion.

func (InstallationRequestSdkVersion) Valid 

func (e InstallationRequestSdkVersion) Valid() bool

Valid indicates whether the value is a known member of the InstallationRequestSdkVersion enum.

type InstallationResponse 

type InstallationResponse struct {
	AuthToken            InstallationAuthToken  `json:"authToken"`
	Fid                  string                 `json:"fid"`
	Name                 string                 `json:"name"`
	RefreshToken         string                 `json:"refreshToken"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

InstallationResponse defines model for InstallationResponse.

func (InstallationResponse) Get 

func (a InstallationResponse) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for InstallationResponse. Returns the specified element and whether it was found

func (InstallationResponse) MarshalJSON 

func (a InstallationResponse) MarshalJSON() ([]byte, error)

Override default JSON handling for InstallationResponse to handle AdditionalProperties

func (*InstallationResponse) Set 

func (a *InstallationResponse) Set(fieldName string, value interface{})

Setter for additional properties for InstallationResponse

func (*InstallationResponse) UnmarshalJSON 

func (a *InstallationResponse) UnmarshalJSON(b []byte) error

Override default JSON handling for InstallationResponse to handle AdditionalProperties

type JSONAccept 

type JSONAccept string

JSONAccept defines model for JSONAccept. 

const (
	JSONAcceptApplicationjson JSONAccept = "application/json"
)

Defines values for JSONAccept.

func (JSONAccept) Valid 

func (e JSONAccept) Valid() bool

Valid indicates whether the value is a known member of the JSONAccept enum.

type JSONContentType 

type JSONContentType string

JSONContentType defines model for JSONContentType. 

const (
	JSONContentTypeApplicationjson JSONContentType = "application/json"
)

Defines values for JSONContentType.

func (JSONContentType) Valid 

func (e JSONContentType) Valid() bool

Valid indicates whether the value is a known member of the JSONContentType enum.

type LegacyRegistrationRequest 

type LegacyRegistrationRequest struct {
	XSubtype LegacyRegistrationRequestXSubtype `json:"X-subtype"`
	App      LegacyRegistrationRequestApp      `json:"app"`
	Device   string                            `json:"device"`
	Sender   LegacyRegistrationRequestSender   `json:"sender"`
}

LegacyRegistrationRequest Form fields are URL encoded as UTF-8.

type LegacyRegistrationRequestApp 

type LegacyRegistrationRequestApp string

LegacyRegistrationRequestApp defines model for LegacyRegistrationRequest.App. 

const (
	OrgChromiumLinux LegacyRegistrationRequestApp = "org.chromium.linux"
)

Defines values for LegacyRegistrationRequestApp.

func (LegacyRegistrationRequestApp) Valid 

func (e LegacyRegistrationRequestApp) Valid() bool

Valid indicates whether the value is a known member of the LegacyRegistrationRequestApp enum.

type LegacyRegistrationRequestSender 

type LegacyRegistrationRequestSender string

LegacyRegistrationRequestSender defines model for LegacyRegistrationRequest.Sender. 

const (
	BDOU99H67HcA6JeFXHbSNMu7e2yNNu3RzoMj8TM4W88jITfq7ZmPvIM1Iv4L2LxQcYwhqby2xGpWwzjfAnG4 LegacyRegistrationRequestSender = "BDOU99-h67HcA6JeFXHbSNMu7e2yNNu3RzoMj8TM4W88jITfq7ZmPvIM1Iv-4_l2LxQcYwhqby2xGpWwzjfAnG4"
)

Defines values for LegacyRegistrationRequestSender.

func (LegacyRegistrationRequestSender) Valid 

func (e LegacyRegistrationRequestSender) Valid() bool

Valid indicates whether the value is a known member of the LegacyRegistrationRequestSender enum.

type LegacyRegistrationRequestXSubtype 

type LegacyRegistrationRequestXSubtype string

LegacyRegistrationRequestXSubtype defines model for LegacyRegistrationRequest.XSubtype. 

const (
	LegacyRegistrationRequestXSubtypeN1876313859327AndroidE10ec6ddb3c81f39 LegacyRegistrationRequestXSubtype = "1:876313859327:android:e10ec6ddb3c81f39"
)

Defines values for LegacyRegistrationRequestXSubtype.

func (LegacyRegistrationRequestXSubtype) Valid 

func (e LegacyRegistrationRequestXSubtype) Valid() bool

Valid indicates whether the value is a known member of the LegacyRegistrationRequestXSubtype enum.

type LegacyRegistrationResponse 

type LegacyRegistrationResponse = string

LegacyRegistrationResponse Form-encoded response containing the registration token.

type ProtobufContentType 

type ProtobufContentType string

ProtobufContentType defines model for ProtobufContentType. 

const (
	ProtobufContentTypeApplicationxProtobuf ProtobufContentType = "application/x-protobuf"
)

Defines values for ProtobufContentType.

func (ProtobufContentType) Valid 

func (e ProtobufContentType) Valid() bool

Valid indicates whether the value is a known member of the ProtobufContentType enum.

type RegisterFCMClientFormdataRequestBody 

type RegisterFCMClientFormdataRequestBody = LegacyRegistrationRequest

RegisterFCMClientFormdataRequestBody defines body for RegisterFCMClient for application/x-www-form-urlencoded ContentType.

type RegisterFCMClientParams 

type RegisterFCMClientParams struct {
	ContentType RegisterFCMClientParamsContentType `json:"Content-Type"`

	// Authorization Android ID and security token from the check-in response.
	Authorization string `json:"Authorization"`

	// UserAgent The pinned receiver sends an empty User-Agent value.
	UserAgent string `json:"User-Agent"`
}

RegisterFCMClientParams defines parameters for RegisterFCMClient.

type RegisterFCMClientParamsContentType 

type RegisterFCMClientParamsContentType string

RegisterFCMClientParamsContentType defines parameters for RegisterFCMClient. 

const (
	ApplicationxWwwFormUrlencoded RegisterFCMClientParamsContentType = "application/x-www-form-urlencoded"
)

Defines values for RegisterFCMClientParamsContentType.

func (RegisterFCMClientParamsContentType) Valid 

func (e RegisterFCMClientParamsContentType) Valid() bool

Valid indicates whether the value is a known member of the RegisterFCMClientParamsContentType enum.

type RegisterFCMClientResponse 

type RegisterFCMClientResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseRegisterFCMClientResponse 

func ParseRegisterFCMClientResponse(rsp *http.Response) (*RegisterFCMClientResponse, error)

ParseRegisterFCMClientResponse parses an HTTP response from a RegisterFCMClientWithResponse call

func (RegisterFCMClientResponse) ContentType 

func (r RegisterFCMClientResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterFCMClientResponse) GetBody 

func (r RegisterFCMClientResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RegisterFCMClientResponse) Status 

func (r RegisterFCMClientResponse) Status() string

Status returns HTTPResponse.Status

func (RegisterFCMClientResponse) StatusCode 

func (r RegisterFCMClientResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RegisterFCMInstallationJSONRequestBody 

type RegisterFCMInstallationJSONRequestBody = FCMRegistrationRequest

RegisterFCMInstallationJSONRequestBody defines body for RegisterFCMInstallation for application/json ContentType.

type RegisterFCMInstallationParams 

type RegisterFCMInstallationParams struct {
	ContentType RegisterFCMInstallationParamsContentType `json:"Content-Type"`

	// XGoogApiKey Public API key configured by the pinned Ring Android client.
	XGoogApiKey RegisterFCMInstallationParamsXGoogApiKey `json:"X-Goog-Api-Key"`

	// XGoogFirebaseInstallationsAuth The local compatibility adapter removes the upstream FIS prefix before forwarding.
	XGoogFirebaseInstallationsAuth string `json:"X-Goog-Firebase-Installations-Auth"`
}

RegisterFCMInstallationParams defines parameters for RegisterFCMInstallation.

type RegisterFCMInstallationParamsContentType 

type RegisterFCMInstallationParamsContentType string

RegisterFCMInstallationParamsContentType defines parameters for RegisterFCMInstallation. 

const (
	RegisterFCMInstallationParamsContentTypeApplicationjson RegisterFCMInstallationParamsContentType = "application/json"
)

Defines values for RegisterFCMInstallationParamsContentType.

func (RegisterFCMInstallationParamsContentType) Valid 

func (e RegisterFCMInstallationParamsContentType) Valid() bool

Valid indicates whether the value is a known member of the RegisterFCMInstallationParamsContentType enum.

type RegisterFCMInstallationParamsXGoogApiKey 

type RegisterFCMInstallationParamsXGoogApiKey string

RegisterFCMInstallationParamsXGoogApiKey defines parameters for RegisterFCMInstallation. 

const (
	RegisterFCMInstallationParamsXGoogApiKeyAIzaSyCvHdFBmmdBBJadNyTFwBXNH5m3Bk8 RegisterFCMInstallationParamsXGoogApiKey = "AIzaSyCv-hdFBmmdBBJadNy-TFwB-xN_H5m3Bk8"
)

Defines values for RegisterFCMInstallationParamsXGoogApiKey.

func (RegisterFCMInstallationParamsXGoogApiKey) Valid 

func (e RegisterFCMInstallationParamsXGoogApiKey) Valid() bool

Valid indicates whether the value is a known member of the RegisterFCMInstallationParamsXGoogApiKey enum.

type RegisterFCMInstallationResponse 

type RegisterFCMInstallationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FCMRegistrationResponse
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *FCMRegistrationResponse
}

func ParseRegisterFCMInstallationResponse 

func ParseRegisterFCMInstallationResponse(rsp *http.Response) (*RegisterFCMInstallationResponse, error)

ParseRegisterFCMInstallationResponse parses an HTTP response from a RegisterFCMInstallationWithResponse call

func (RegisterFCMInstallationResponse) ContentType 

func (r RegisterFCMInstallationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterFCMInstallationResponse) GetBody 

func (r RegisterFCMInstallationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RegisterFCMInstallationResponse) GetJSON200 

func (r RegisterFCMInstallationResponse) GetJSON200() *FCMRegistrationResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RegisterFCMInstallationResponse) GetJSON201 

func (r RegisterFCMInstallationResponse) GetJSON201() *FCMRegistrationResponse

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (RegisterFCMInstallationResponse) Status 

func (r RegisterFCMInstallationResponse) Status() string

Status returns HTTPResponse.Status

func (RegisterFCMInstallationResponse) StatusCode 

func (r RegisterFCMInstallationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RingPushNotificationConfig 

type RingPushNotificationConfig struct {
	// Category Open Ring action category, such as ding or motion.
	Category             *string                `json:"category,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

RingPushNotificationConfig Optional Ring category in an MCS notification's android_config JSON string.

func (RingPushNotificationConfig) Get 

func (a RingPushNotificationConfig) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for RingPushNotificationConfig. Returns the specified element and whether it was found

func (RingPushNotificationConfig) MarshalJSON 

func (a RingPushNotificationConfig) MarshalJSON() ([]byte, error)

Override default JSON handling for RingPushNotificationConfig to handle AdditionalProperties

func (*RingPushNotificationConfig) Set 

func (a *RingPushNotificationConfig) Set(fieldName string, value interface{})

Setter for additional properties for RingPushNotificationConfig

func (*RingPushNotificationConfig) UnmarshalJSON 

func (a *RingPushNotificationConfig) UnmarshalJSON(b []byte) error

Override default JSON handling for RingPushNotificationConfig to handle AdditionalProperties

type RingPushNotificationDevice 

type RingPushNotificationDevice struct {
	Id                   *int64                 `json:"id,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

RingPushNotificationDevice defines model for RingPushNotificationDevice.

func (RingPushNotificationDevice) Get 

func (a RingPushNotificationDevice) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for RingPushNotificationDevice. Returns the specified element and whether it was found

func (RingPushNotificationDevice) MarshalJSON 

func (a RingPushNotificationDevice) MarshalJSON() ([]byte, error)

Override default JSON handling for RingPushNotificationDevice to handle AdditionalProperties

func (*RingPushNotificationDevice) Set 

func (a *RingPushNotificationDevice) Set(fieldName string, value interface{})

Setter for additional properties for RingPushNotificationDevice

func (*RingPushNotificationDevice) UnmarshalJSON 

func (a *RingPushNotificationDevice) UnmarshalJSON(b []byte) error

Override default JSON handling for RingPushNotificationDevice to handle AdditionalProperties

type RingPushNotificationGCMData 

type RingPushNotificationGCMData struct {
	// Action Open Ring action name, including intercom_unlock.
	Action               *string                `json:"action,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

RingPushNotificationGCMData defines model for RingPushNotificationGCMData.

func (RingPushNotificationGCMData) Get 

func (a RingPushNotificationGCMData) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for RingPushNotificationGCMData. Returns the specified element and whether it was found

func (RingPushNotificationGCMData) MarshalJSON 

func (a RingPushNotificationGCMData) MarshalJSON() ([]byte, error)

Override default JSON handling for RingPushNotificationGCMData to handle AdditionalProperties

func (*RingPushNotificationGCMData) Set 

func (a *RingPushNotificationGCMData) Set(fieldName string, value interface{})

Setter for additional properties for RingPushNotificationGCMData

func (*RingPushNotificationGCMData) UnmarshalJSON 

func (a *RingPushNotificationGCMData) UnmarshalJSON(b []byte) error

Override default JSON handling for RingPushNotificationGCMData to handle AdditionalProperties

type RingPushNotificationPayload 

type RingPushNotificationPayload struct {
	Device               *RingPushNotificationDevice  `json:"device,omitempty"`
	GcmData              *RingPushNotificationGCMData `json:"gcmData,omitempty"`
	AdditionalProperties map[string]interface{}       `json:"-"`
}

RingPushNotificationPayload Optional Ring data object carried as a JSON string in an MCS notification.

func (RingPushNotificationPayload) Get 

func (a RingPushNotificationPayload) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for RingPushNotificationPayload. Returns the specified element and whether it was found

func (RingPushNotificationPayload) MarshalJSON 

func (a RingPushNotificationPayload) MarshalJSON() ([]byte, error)

Override default JSON handling for RingPushNotificationPayload to handle AdditionalProperties

func (*RingPushNotificationPayload) Set 

func (a *RingPushNotificationPayload) Set(fieldName string, value interface{})

Setter for additional properties for RingPushNotificationPayload

func (*RingPushNotificationPayload) UnmarshalJSON 

func (a *RingPushNotificationPayload) UnmarshalJSON(b []byte) error

Override default JSON handling for RingPushNotificationPayload to handle AdditionalProperties

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.