policies_with_namespace_v2

package
v0.77.2 Latest Latest
Warning

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

Go to latest
Published: Feb 25, 2025 License: MIT Imports: 15 Imported by: 0

Documentation

Index

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 policies with namespace v2 API

func (*Client) RetrieveLatestPoliciesByNamespaceAndCountryPublic1 deprecated

Deprecated: 2022-08-10 - Use RetrieveLatestPoliciesByNamespaceAndCountryPublic1Short instead.

RetrieveLatestPoliciesByNamespaceAndCountryPublic1 retrieve latest policies by namespace and country This API is used to list all the related doc in register page, include optional & mandatory (when env config APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=true). Other detail info: Here are the result of different cases

  • Document 1, Region US (default, mandatory), UA (optional); clientID: [client_A]
  • Document 2, Region US (default, optional), UA (mandatory); clientID: [client_A]
  • Document 3, Region UA (default, mandatory); clientID: [client_A]
  • Document 4, Region US (default, optional); clientID: [client_A]
  • Document 5, Region US (default, optional); clientID: [client_B]
  • Document 6, Region CA (mandatory, optional), UA (optional); clientID: [client_B]
  • Query by: Region UA + client_A
  • Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional)
  • Query by: Region CA + client_A
  • Response: Document 1 (US, mandatory), Document 2 (US, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional)
  • Query by: Region UA + client_B
  • Response: Document 5 (US, optional), Document 6 (UA, optional)
  • Query by: Region CN + client_B
  • Response: Document 5 (US, optional), Document 6 (CA, mandatory)

Note: If APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=false the behavior will be same with `/agreement/public/policies/namespaces/{namespace}/countries/{country_code}?defaultOnEmpty=true&visibleOnly;=true`;Here are the result of different cases

  • Query by: Region UA + client_A
  • Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory)
  • Query by: Region UA + client_B
  • Response: Document 5 (US, optional)

func (*Client) RetrieveLatestPoliciesByNamespaceAndCountryPublic1Short

func (a *Client) RetrieveLatestPoliciesByNamespaceAndCountryPublic1Short(params *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK, error)

RetrieveLatestPoliciesByNamespaceAndCountryPublic1Short retrieve latest policies by namespace and country This API is used to list all the related doc in register page, include optional & mandatory (when env config APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=true). Other detail info: Here are the result of different cases

  • Document 1, Region US (default, mandatory), UA (optional); clientID: [client_A]
  • Document 2, Region US (default, optional), UA (mandatory); clientID: [client_A]
  • Document 3, Region UA (default, mandatory); clientID: [client_A]
  • Document 4, Region US (default, optional); clientID: [client_A]
  • Document 5, Region US (default, optional); clientID: [client_B]
  • Document 6, Region CA (mandatory, optional), UA (optional); clientID: [client_B]
  • Query by: Region UA + client_A
  • Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional)
  • Query by: Region CA + client_A
  • Response: Document 1 (US, mandatory), Document 2 (US, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional)
  • Query by: Region UA + client_B
  • Response: Document 5 (US, optional), Document 6 (UA, optional)
  • Query by: Region CN + client_B
  • Response: Document 5 (US, optional), Document 6 (CA, mandatory)

Note: If APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=false the behavior will be same with `/agreement/public/policies/namespaces/{namespace}/countries/{country_code}?defaultOnEmpty=true&visibleOnly;=true`;Here are the result of different cases

  • Query by: Region UA + client_A
  • Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory)
  • Query by: Region UA + client_B
  • Response: Document 5 (US, optional)

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	RetrieveLatestPoliciesByNamespaceAndCountryPublic1(params *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK, error)
	RetrieveLatestPoliciesByNamespaceAndCountryPublic1Short(params *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK, 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 policies with namespace v2 API client.

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK struct {
	Payload []*legalclientmodels.RetrieveSimplePolicyPublicResponseV2
}

RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK handles this case with default header values.

successful operation

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1OK

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1OK() *RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK

NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1OK creates a RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK with default headers values

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK) Error

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK) GetPayload

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1OK) ToJSONString

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*CountryCode
	  Country Code

	*/
	CountryCode string
	/*Namespace
	  Namespace

	*/
	Namespace string
	/*ClientID
	  clientId, which used to login

	*/
	ClientID 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
}

RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params contains all the parameters to send to the API endpoint for the retrieve latest policies by namespace and country public 1 operation typically these are written to a http.Request

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1Params() *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1Params creates a new RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params object with the default values initialized.

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithContext

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithContext(ctx context.Context) *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithContext creates a new RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params object with the default values initialized, and the ability to set a context for a request

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithHTTPClient

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithHTTPClient(client *http.Client) *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithHTTPClient creates a new RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithTimeout

func NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithTimeout(timeout time.Duration) *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params

NewRetrieveLatestPoliciesByNamespaceAndCountryPublic1ParamsWithTimeout creates a new RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params object with the default values initialized, and the ability to set a timeout on a request

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetAuthInfoWriter

SetAuthInfoWriter adds the authInfoWriter to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetClientID

SetClientID adds the clientId to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetContext

SetContext adds the context to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetCountryCode

SetCountryCode adds the countryCode to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetFlightId

SetFlightId adds the flightId as the header value for this specific endpoint

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetHTTPClient

SetHTTPClient adds the HTTPClient to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetHTTPClientTransport

func (o *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetNamespace

SetNamespace adds the namespace to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) SetTimeout

SetTimeout adds the timeout to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithClientID

WithClientID adds the clientID to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithContext

WithContext adds the context to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithCountryCode

WithCountryCode adds the countryCode to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithHTTPClient

WithHTTPClient adds the HTTPClient to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithNamespace

WithNamespace adds the namespace to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WithTimeout

WithTimeout adds the timeout to the retrieve latest policies by namespace and country public 1 params

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Params) WriteToRequest

WriteToRequest writes these params to a swagger request

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1Reader

type RetrieveLatestPoliciesByNamespaceAndCountryPublic1Reader struct {
	// contains filtered or unexported fields
}

RetrieveLatestPoliciesByNamespaceAndCountryPublic1Reader is a Reader for the RetrieveLatestPoliciesByNamespaceAndCountryPublic1 structure.

func (*RetrieveLatestPoliciesByNamespaceAndCountryPublic1Reader) ReadResponse

func (o *RetrieveLatestPoliciesByNamespaceAndCountryPublic1Reader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL