lib/api/members/members_client/events/events_client.go

// Code generated by go-swagger; DO NOT EDIT.

// (c) 2012-2020 by Taxnexus, Inc.
// All rights reserved worldwide.
// Proprietary product; unlicensed use is not allowed

package events

import (
	"context"
	"fmt"
	"time"

	"github.com/go-openapi/runtime"
	httptransport "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
)

// New creates a new events API client.
func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService {
	return &Client{transport: transport, formats: formats}
}

// New creates a new events API client with basic auth credentials.
//
// It takes the following parameters:
// - host: http host (github.com).
// - basePath: any base path for the API client ("/v1", "/v3").
// - scheme: http scheme ("http", "https").
// - user: user for basic authentication header.
// - password: password for basic authentication header.
func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService {
	transport := httptransport.New(host, basePath, []string{scheme})
	transport.DefaultAuthentication = httptransport.BasicAuth(user, password)
	return &Client{transport: transport, formats: strfmt.Default}
}

// New creates a new events API client with a bearer token for authentication.
//
// It takes the following parameters:
// - host: http host (github.com).
// - basePath: any base path for the API client ("/v1", "/v3").
// - scheme: http scheme ("http", "https").
// - bearerToken: bearer token for Bearer authentication header.
func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService {
	transport := httptransport.New(host, basePath, []string{scheme})
	transport.DefaultAuthentication = httptransport.BearerToken(bearerToken)
	return &Client{transport: transport, formats: strfmt.Default}
}

// Client for events API.
type Client struct {
	transport runtime.ContextualTransport
	formats   strfmt.Registry
}

// ClientOption may be used to customize the behavior of Client methods.
type ClientOption func(*runtime.ClientOperation)

// ClientService is the interface for Client methods.
type ClientService interface {

	// GetEventCategories get a list of eventcategories.
	GetEventCategories(params *GetEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventCategoriesOK, error)

	// GetEventCategoriesContext get a list of eventcategories.
	GetEventCategoriesContext(ctx context.Context, params *GetEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventCategoriesOK, error)

	// GetEvents get a list of events.
	GetEvents(params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventsOK, error)

	// GetEventsContext get a list of events.
	GetEventsContext(ctx context.Context, params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventsOK, error)

	// PostEventCategories create a new event category.
	PostEventCategories(params *PostEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventCategoriesOK, error)

	// PostEventCategoriesContext create a new event category.
	PostEventCategoriesContext(ctx context.Context, params *PostEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventCategoriesOK, error)

	// PostEvents create a new event.
	PostEvents(params *PostEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventsOK, error)

	// PostEventsContext create a new event.
	PostEventsContext(ctx context.Context, params *PostEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventsOK, error)

	// PutEventCategories update an event category.
	PutEventCategories(params *PutEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventCategoriesOK, error)

	// PutEventCategoriesContext update an event category.
	PutEventCategoriesContext(ctx context.Context, params *PutEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventCategoriesOK, error)

	// PutEvents update an event.
	PutEvents(params *PutEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventsOK, error)

	// PutEventsContext update an event.
	PutEventsContext(ctx context.Context, params *PutEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventsOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

// GetEventCategories gets a list of eventcategories.
//
// List or get estate-global event categories for an active member of the configured Keenan Vision tenant. Requires members:event-category:read and compound machine plus native-user authentication..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.GetEventCategoriesContext] instead.
func (a *Client) GetEventCategories(params *GetEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventCategoriesOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.GetEventCategoriesContext(ctx, params, authInfo, opts...)
}

// GetEventCategoriesContext gets a list of eventcategories.
//
// List or get estate-global event categories for an active member of the configured Keenan Vision tenant. Requires members:event-category:read and compound machine plus native-user authentication..
//
// Do not use the deprecated [GetEventCategoriesParams.Context] with this method: it would be ignored.
func (a *Client) GetEventCategoriesContext(ctx context.Context, params *GetEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventCategoriesOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewGetEventCategoriesParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "getEventCategories",
		Method:             "GET",
		PathPattern:        "/eventcategories",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &GetEventCategoriesReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*GetEventCategoriesOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for getEventCategories: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// GetEvents gets a list of events.
//
// List or get events owned by active members of the configured Keenan Vision tenant. Requires members:event:read and compound machine plus native-user authentication. Owners and Managers can read tenant-owned events; Contributors can read only events they organize..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.GetEventsContext] instead.
func (a *Client) GetEvents(params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.GetEventsContext(ctx, params, authInfo, opts...)
}

// GetEventsContext gets a list of events.
//
// List or get events owned by active members of the configured Keenan Vision tenant. Requires members:event:read and compound machine plus native-user authentication. Owners and Managers can read tenant-owned events; Contributors can read only events they organize..
//
// Do not use the deprecated [GetEventsParams.Context] with this method: it would be ignored.
func (a *Client) GetEventsContext(ctx context.Context, params *GetEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEventsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewGetEventsParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "getEvents",
		Method:             "GET",
		PathPattern:        "/events",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &GetEventsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*GetEventsOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for getEvents: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PostEventCategories creates a new event category.
//
// Create one estate-global event category. Requires members:event-category:create and Keenan Vision Owner or Manager access. ID and audit fields are server-owned..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.PostEventCategoriesContext] instead.
func (a *Client) PostEventCategories(params *PostEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventCategoriesOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PostEventCategoriesContext(ctx, params, authInfo, opts...)
}

// PostEventCategoriesContext creates a new event category.
//
// Create one estate-global event category. Requires members:event-category:create and Keenan Vision Owner or Manager access. ID and audit fields are server-owned..
//
// Do not use the deprecated [PostEventCategoriesParams.Context] with this method: it would be ignored.
func (a *Client) PostEventCategoriesContext(ctx context.Context, params *PostEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventCategoriesOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPostEventCategoriesParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "postEventCategories",
		Method:             "POST",
		PathPattern:        "/eventcategories",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PostEventCategoriesReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*PostEventCategoriesOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for postEventCategories: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PostEvents creates a new event.
//
// Create one event owned by an active organizer in the configured Keenan Vision tenant. Requires members:event:create and Keenan Vision Owner or Manager access. AccountID remains read-only until a governed CRM relationship is available..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.PostEventsContext] instead.
func (a *Client) PostEvents(params *PostEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PostEventsContext(ctx, params, authInfo, opts...)
}

// PostEventsContext creates a new event.
//
// Create one event owned by an active organizer in the configured Keenan Vision tenant. Requires members:event:create and Keenan Vision Owner or Manager access. AccountID remains read-only until a governed CRM relationship is available..
//
// Do not use the deprecated [PostEventsParams.Context] with this method: it would be ignored.
func (a *Client) PostEventsContext(ctx context.Context, params *PostEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostEventsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPostEventsParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "postEvents",
		Method:             "POST",
		PathPattern:        "/events",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PostEventsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*PostEventsOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for postEvents: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PutEventCategories updates an event category.
//
// CAS-update one estate-global event category. Requires members:event-category:update and Keenan Vision Owner or Manager access. ID and audit fields are server-owned; delete is unavailable..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.PutEventCategoriesContext] instead.
func (a *Client) PutEventCategories(params *PutEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventCategoriesOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PutEventCategoriesContext(ctx, params, authInfo, opts...)
}

// PutEventCategoriesContext updates an event category.
//
// CAS-update one estate-global event category. Requires members:event-category:update and Keenan Vision Owner or Manager access. ID and audit fields are server-owned; delete is unavailable..
//
// Do not use the deprecated [PutEventCategoriesParams.Context] with this method: it would be ignored.
func (a *Client) PutEventCategoriesContext(ctx context.Context, params *PutEventCategoriesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventCategoriesOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPutEventCategoriesParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "putEventCategories",
		Method:             "PUT",
		PathPattern:        "/eventcategories",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PutEventCategoriesReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*PutEventCategoriesOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for putEventCategories: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// PutEvents updates an event.
//
// CAS-update one event already owned by the configured Keenan Vision tenant. Requires members:event:update and Keenan Vision Owner or Manager access. AccountID and audit fields are server-owned or read-only; delete is unavailable..
//
// This method does not support injected context.
// However, timeout and opentracing contexts are honored whenever enabled.
//
// If you need to pass a specific context, use [Client.PutEventsContext] instead.
func (a *Client) PutEvents(params *PutEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventsOK, error) {
	var ctx context.Context
	if params.inner.ctx != nil {
		ctx = params.inner.ctx
	} else {
		ctx = context.Background()
	}

	return a.PutEventsContext(ctx, params, authInfo, opts...)
}

// PutEventsContext updates an event.
//
// CAS-update one event already owned by the configured Keenan Vision tenant. Requires members:event:update and Keenan Vision Owner or Manager access. AccountID and audit fields are server-owned or read-only; delete is unavailable..
//
// Do not use the deprecated [PutEventsParams.Context] with this method: it would be ignored.
func (a *Client) PutEventsContext(ctx context.Context, params *PutEventsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PutEventsOK, error) {
	// NOTE: parameters are not validated before sending
	if params == nil {
		params = NewPutEventsParams()
	}

	op := &runtime.ClientOperation{
		ID:                 "putEvents",
		Method:             "PUT",
		PathPattern:        "/events",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"http"},
		Params:             params,
		Reader:             &PutEventsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Client:             params.HTTPClient,
	}

	for _, opt := range opts {
		opt(op)
	}

	result, err := a.transport.SubmitContext(ctx, op)
	if err != nil {
		return nil, err
	}

	// only one success response has to be checked
	success, ok := result.(*PutEventsOK)
	if ok {
		return success, nil
	}

	// unexpected success response.

	// no default response is defined.
	//
	// safeguard: normally, in the absence of a default response, unknown success responses return an error above: so this is a codegen issue
	msg := fmt.Sprintf("unexpected success response for putEvents: API contract not enforced by server. Client expected to get an error, but got: %T", result)
	panic(msg)
}

// SetTransport changes the transport on the client
func (a *Client) SetTransport(transport runtime.ContextualTransport) {
	a.transport = transport
}

// innerParams captures internal fields so they don't conflict with user-supplied parameters.
type innerParams struct {
	timeout time.Duration

	// Deprecated: use the operation call with context to pass the context instead of [EventsParams].
	ctx context.Context
}