// 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 documents

import (
	"context"
	"net/http"
	"time"

	"github.com/go-openapi/errors"
	"github.com/go-openapi/runtime"
	cr "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag/conv"
)

// NewGetDocumentsParams creates a new GetDocumentsParams object,
// with the default timeout for this client.
//
// Default values are not hydrated, since defaults are normally applied by the API server side.
//
// To enforce default values in parameter, use SetDefaults or WithDefaults.
func NewGetDocumentsParams() *GetDocumentsParams {
	return NewGetDocumentsParamsWithTimeout(cr.DefaultTimeout)
}

// NewGetDocumentsParamsWithTimeout creates a new GetDocumentsParams object
// with the ability to set a timeout on a request.
func NewGetDocumentsParamsWithTimeout(timeout time.Duration) *GetDocumentsParams {
	return &GetDocumentsParams{
		inner: innerParams{
			timeout: timeout,
		},
	}
}

// NewGetDocumentsParamsWithContext creates a new GetDocumentsParams object
// with the ability to set a context for a request.
//
// Deprecated: use the operation call with context to pass the context instead of [GetDocumentsParams].
func NewGetDocumentsParamsWithContext(ctx context.Context) *GetDocumentsParams {
	return &GetDocumentsParams{
		inner: innerParams{
			ctx: ctx,
		},
	}
}

// NewGetDocumentsParamsWithHTTPClient creates a new GetDocumentsParams object
// with the ability to set a custom HTTPClient for a request.
func NewGetDocumentsParamsWithHTTPClient(client *http.Client) *GetDocumentsParams {
	return &GetDocumentsParams{
		HTTPClient: client,
	}
}

/*
GetDocumentsParams contains all the parameters to send to the API endpoint

	for the get documents operation.

	Typically these are written to a http.Request.
*/
type GetDocumentsParams struct {

	// ID.
	//
	// Unique Record ID
	ID *string

	// Limit.
	//
	// How many objects to return at one time
	//
	// Format: int64
	Limit *int64

	// Offset.
	//
	// How many objects to skip?
	//
	// Format: int64
	Offset *int64

	HTTPClient *http.Client

	inner innerParams
}

// WithDefaults hydrates default values in the get documents params (not the query body).
//
// All values with no default are reset to their zero value.
func (o *GetDocumentsParams) WithDefaults() *GetDocumentsParams {
	o.SetDefaults()
	return o
}

// SetDefaults hydrates default values in the get documents params (not the query body).
//
// All values with no default are reset to their zero value.
func (o *GetDocumentsParams) SetDefaults() {
	// no default values defined for this parameter
}

// WithTimeout adds the timeout to the get documents params.
func (o *GetDocumentsParams) WithTimeout(timeout time.Duration) *GetDocumentsParams {
	o.SetTimeout(timeout)
	return o
}

// SetTimeout adds the timeout to the get documents params.
func (o *GetDocumentsParams) SetTimeout(timeout time.Duration) {
	o.inner.timeout = timeout
}

// WithContext adds the context to the get documents params.
//
// Deprecated: use the operation call with context to pass the context instead of [GetDocumentsParams].
func (o *GetDocumentsParams) WithContext(ctx context.Context) *GetDocumentsParams {
	o.SetContext(ctx)
	return o
}

// SetContext adds the context to the get documents params.
//
// Deprecated: use the operation call with context to pass the context instead of [GetDocumentsParams].
func (o *GetDocumentsParams) SetContext(ctx context.Context) {
	o.inner.ctx = ctx
}

// WithHTTPClient adds the HTTPClient to the get documents params.
func (o *GetDocumentsParams) WithHTTPClient(client *http.Client) *GetDocumentsParams {
	o.SetHTTPClient(client)
	return o
}

// SetHTTPClient adds the HTTPClient to the get documents params.
func (o *GetDocumentsParams) SetHTTPClient(client *http.Client) {
	o.HTTPClient = client
}

// WithID adds the id to the get documents params.
func (o *GetDocumentsParams) WithID(id *string) *GetDocumentsParams {
	o.SetID(id)
	return o
}

// SetID adds the id to the get documents params.
func (o *GetDocumentsParams) SetID(id *string) {
	o.ID = id
}

// WithLimit adds the limit to the get documents params.
func (o *GetDocumentsParams) WithLimit(limit *int64) *GetDocumentsParams {
	o.SetLimit(limit)
	return o
}

// SetLimit adds the limit to the get documents params.
func (o *GetDocumentsParams) SetLimit(limit *int64) {
	o.Limit = limit
}

// WithOffset adds the offset to the get documents params.
func (o *GetDocumentsParams) WithOffset(offset *int64) *GetDocumentsParams {
	o.SetOffset(offset)
	return o
}

// SetOffset adds the offset to the get documents params.
func (o *GetDocumentsParams) SetOffset(offset *int64) {
	o.Offset = offset
}

// WriteToRequest writes these params to a [runtime.ClientRequest].
func (o *GetDocumentsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error {
	if err := r.SetTimeout(o.inner.timeout); err != nil {
		return err
	}
	var res []error

	if o.ID != nil {

		// query param id
		var qrID string

		if o.ID != nil {
			qrID = *o.ID
		}
		qID := qrID
		if qID != "" {

			if err := r.SetQueryParam("id", qID); err != nil {
				return err
			}
		}
	}

	if o.Limit != nil {

		// query param limit
		var qrLimit int64

		if o.Limit != nil {
			qrLimit = *o.Limit
		}
		qLimit := conv.FormatInteger(qrLimit)
		if qLimit != "" {

			if err := r.SetQueryParam("limit", qLimit); err != nil {
				return err
			}
		}
	}

	if o.Offset != nil {

		// query param offset
		var qrOffset int64

		if o.Offset != nil {
			qrOffset = *o.Offset
		}
		qOffset := conv.FormatInteger(qrOffset)
		if qOffset != "" {

			if err := r.SetQueryParam("offset", qOffset); err != nil {
				return err
			}
		}
	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}
