swagger

package
v0.0.0-...-898ca94 Latest Latest
Warning

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

 Go to latest Published: Feb 8, 2023 License: MIT Imports: 20 Imported by: 0

README

Go API client for swagger

Extracted from retrofit

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api-inmobile-pl.easypack24.net

Class Method HTTP request Description
DefaultApi V1AuthenticatePost Post /v1/authenticate RegistrationApi.refreshToken
DefaultApi V1CollectCompartmentCloseSessionUuidGet Get /v1/collect/compartment/close/{sessionUuid} CompartmentApi.closeCompartment
DefaultApi V1CollectCompartmentOpenSessionUuidPost Post /v1/collect/compartment/open/{sessionUuid} CompartmentApi.openCompartment
DefaultApi V1CollectCompartmentReopenSessionUuidPost Post /v1/collect/compartment/reopen/{sessionUuid} CompartmentApi.reopenCompartment
DefaultApi V1CollectCompartmentStatusSessionUuidGet Get /v1/collect/compartment/status/{sessionUuid} CompartmentStatusApi.statusCompartment
DefaultApi V1CollectTerminateSessionUuidPost Post /v1/collect/terminate/{sessionUuid} CompartmentApi.terminateCompartment
DefaultApi V1CollectValidatePost Post /v1/collect/validate CompartmentApi.validateCompartment
DefaultApi V1ConfirmSMSCodePhoneNumberSmsCodePost Post /v1/confirmSMSCode/{phoneNumber}/{smsCode} RegistrationApi.confirmSMSCode
DefaultApi V1LogoutPost Post /v1/logout UserApi.logout
DefaultApi V1NotificationsGet Get /v1/notifications NotificationCenterApi.news
DefaultApi V1NotificationsReadAllPost Post /v1/notifications/readAll NotificationCenterApi.markAsReadAll
DefaultApi V1NotificationsReadNotificationIdPost Post /v1/notifications/read/{notificationId} NotificationCenterApi.markAsRead
DefaultApi V1ObservedParcelPost Post /v1/observedParcel ParcelApi.subscribeParcel
DefaultApi V1ObservedParcelShipmentNumberDelete Delete /v1/observedParcel/{shipmentNumber} ParcelApi.removeObservedParcel
DefaultApi V1ParcelGet Get /v1/parcel ParcelApi.parcelsWithDate
DefaultApi V1ParcelShipmentNumberGet Get /v1/parcel/{shipmentNumber} ParcelApi.oneParcel
DefaultApi V1ParcelsGet Get /v1/parcels ParcelApi.parcels
DefaultApi V1PointsGet Get /v1/points MapApi.pointsFor
DefaultApi V1ReturnsTicketsGet Get /v1/returns/tickets ReturnTicketApi.m4664a
DefaultApi V1ReturnsTicketsPost Post /v1/returns/tickets CreateTicketApi.m4707b
DefaultApi V1ReturnsTicketsUuidGet Get /v1/returns/tickets/{uuid} ReturnTicketApi.m4663b
DefaultApi V1SendSMSCodePhoneNumberGet Get /v1/sendSMSCode/{phoneNumber} RegistrationApi.sendSMSCode
DefaultApi V2AgreementGet Get /v2/agreement AgreementApi.agreement
DefaultApi V2AgreementPost Post /v2/agreement AgreementApi.agreement
DefaultApi V2CollectCompartmentClaimSessionUuidPost Post /v2/collect/compartment/claim/{sessionUuid} CompartmentApi.claimCompartment
DefaultApi V2SetPushIdPost Post /v2/setPushId CloudMessagingApi.setPushId

Documentation For Models

Documentation For Authorization

bearerAuth

Author

Documentation

Overview

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Inpost Mobile * * Extracted from retrofit * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source 
var (

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Inpost Mobile API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AddressDetails 

type AddressDetails struct {
	BuildingNumber string `json:"buildingNumber,omitempty"`
	City           string `json:"city,omitempty"`
	FlatNumber     string `json:"flatNumber,omitempty"`
	PostCode       string `json:"postCode,omitempty"`
	Province       string `json:"province,omitempty"`
	Street         string `json:"street,omitempty"`
}

type AgreementGrant 

type AgreementGrant struct {
	AgreementType string `json:"agreementType,omitempty"`
	Email         string `json:"email,omitempty"`
	Status        string `json:"status,omitempty"`
}

type AuthenticateRequest 

type AuthenticateRequest struct {
	PhoneOS      string `json:"phoneOS,omitempty"`
	RefreshToken string `json:"refreshToken,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CashOnDelivery 

type CashOnDelivery struct {
	Paid    bool   `json:"paid,omitempty"`
	PayCode string `json:"payCode,omitempty"`
	Price   string `json:"price,omitempty"`
	Url     string `json:"url,omitempty"`
}

type Compartment 

type Compartment struct {
	Location *Location `json:"location,omitempty"`
	Name     string    `json:"name,omitempty"`
}

type CompartmentClaimRequest 

type CompartmentClaimRequest struct {
	ShipmentNumbers []string `json:"shipmentNumbers,omitempty"`
}

type CompartmentClaimResponse 

type CompartmentClaimResponse struct {
	ActionTime                 int32 `json:"actionTime,omitempty"`
	ConfirmActionTime          int32 `json:"confirmActionTime,omitempty"`
	OpenCompartmentWaitingTime int32 `json:"openCompartmentWaitingTime,omitempty"`
}

type CompartmentCloseResponse 

type CompartmentCloseResponse struct {
	Closed bool `json:"closed,omitempty"`
}

type CompartmentOpenResponse 

type CompartmentOpenResponse struct {
	ActionTime                 int32        `json:"actionTime,omitempty"`
	Compartment                *Compartment `json:"compartment,omitempty"`
	ConfirmActionTime          int32        `json:"confirmActionTime,omitempty"`
	OpenCompartmentWaitingTime int32        `json:"openCompartmentWaitingTime,omitempty"`
}

type CompartmentStatusResponse 

type CompartmentStatusResponse struct {
	Compartment *Compartment `json:"compartment,omitempty"`
	Status      string       `json:"status,omitempty"`
}

type CompartmentValidateResponse 

type CompartmentValidateResponse struct {
	SessionExpirationTime int32  `json:"sessionExpirationTime,omitempty"`
	SessionUuid           string `json:"sessionUuid,omitempty"`
}

type Completable 

type Completable struct {
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfirmSmsResponse 

type ConfirmSmsResponse struct {
	AuthToken    string `json:"authToken,omitempty"`
	RefreshToken string `json:"refreshToken,omitempty"`
}

type CreateOrganizationTicketRequest 

type CreateOrganizationTicketRequest struct {
	Address          string               `json:"address,omitempty"`
	Description      string               `json:"description,omitempty"`
	OrderNumber      string               `json:"orderNumber,omitempty"`
	OrganizationUuid string               `json:"organizationUuid,omitempty"`
	ParcelSize       string               `json:"parcelSize,omitempty"`
	ReasonUuid       string               `json:"reasonUuid,omitempty"`
	Sender           *ReturnSenderNetwork `json:"sender,omitempty"`
}

type CreateTicketDetailsNetwork 

type CreateTicketDetailsNetwork struct {
	Accepted bool   `json:"accepted,omitempty"`
	Rma      string `json:"rma,omitempty"`
	Uuid     string `json:"uuid,omitempty"`
}

type DefaultApiService 

type DefaultApiService service

func (*DefaultApiService) V1AuthenticatePost 

func (a *DefaultApiService) V1AuthenticatePost(ctx context.Context, localVarOptionals *DefaultApiV1AuthenticatePostOpts) (RefreshTokenResponse, *http.Response, error)

func (*DefaultApiService) V1CollectCompartmentCloseSessionUuidGet 

func (a *DefaultApiService) V1CollectCompartmentCloseSessionUuidGet(ctx context.Context, sessionUuid string) (CompartmentCloseResponse, *http.Response, error)

DefaultApiService CompartmentApi.closeCompartment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sessionUuid CompartmentApi.closeCompartment.str

@return CompartmentCloseResponse

func (*DefaultApiService) V1CollectCompartmentOpenSessionUuidPost 

func (a *DefaultApiService) V1CollectCompartmentOpenSessionUuidPost(ctx context.Context, sessionUuid string) (CompartmentOpenResponse, *http.Response, error)

DefaultApiService CompartmentApi.openCompartment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sessionUuid CompartmentApi.openCompartment.str

@return CompartmentOpenResponse

func (*DefaultApiService) V1CollectCompartmentReopenSessionUuidPost 

func (a *DefaultApiService) V1CollectCompartmentReopenSessionUuidPost(ctx context.Context, sessionUuid string) (CompartmentOpenResponse, *http.Response, error)

DefaultApiService CompartmentApi.reopenCompartment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sessionUuid CompartmentApi.reopenCompartment.str

@return CompartmentOpenResponse

func (*DefaultApiService) V1CollectCompartmentStatusSessionUuidGet 

func (a *DefaultApiService) V1CollectCompartmentStatusSessionUuidGet(ctx context.Context, sessionUuid string, localVarOptionals *DefaultApiV1CollectCompartmentStatusSessionUuidGetOpts) (CompartmentStatusResponse, *http.Response, error)

func (*DefaultApiService) V1CollectTerminateSessionUuidPost 

func (a *DefaultApiService) V1CollectTerminateSessionUuidPost(ctx context.Context, sessionUuid string) (Completable, *http.Response, error)

DefaultApiService CompartmentApi.terminateCompartment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sessionUuid CompartmentApi.terminateCompartment.str

@return Completable

func (*DefaultApiService) V1CollectValidatePost 

func (a *DefaultApiService) V1CollectValidatePost(ctx context.Context, localVarOptionals *DefaultApiV1CollectValidatePostOpts) (CompartmentValidateResponse, *http.Response, error)

func (*DefaultApiService) V1ConfirmSMSCodePhoneNumberSmsCodePost 

func (a *DefaultApiService) V1ConfirmSMSCodePhoneNumberSmsCodePost(ctx context.Context, phoneNumber string, smsCode string, localVarOptionals *DefaultApiV1ConfirmSMSCodePhoneNumberSmsCodePostOpts) (ConfirmSmsResponse, *http.Response, error)

func (*DefaultApiService) V1LogoutPost 

func (a *DefaultApiService) V1LogoutPost(ctx context.Context) (Completable, *http.Response, error)

DefaultApiService UserApi.logout

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return Completable

func (*DefaultApiService) V1NotificationsGet 

func (a *DefaultApiService) V1NotificationsGet(ctx context.Context, localVarOptionals *DefaultApiV1NotificationsGetOpts) (NotificationResponse, *http.Response, error)

func (*DefaultApiService) V1NotificationsReadAllPost 

func (a *DefaultApiService) V1NotificationsReadAllPost(ctx context.Context, localVarOptionals *DefaultApiV1NotificationsReadAllPostOpts) (NotificationData, *http.Response, error)

func (*DefaultApiService) V1NotificationsReadNotificationIdPost 

func (a *DefaultApiService) V1NotificationsReadNotificationIdPost(ctx context.Context, notificationId string) (NotificationData, *http.Response, error)

DefaultApiService NotificationCenterApi.markAsRead

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param notificationId NotificationCenterApi.markAsRead.str

@return NotificationData

func (*DefaultApiService) V1ObservedParcelPost 

func (a *DefaultApiService) V1ObservedParcelPost(ctx context.Context, localVarOptionals *DefaultApiV1ObservedParcelPostOpts) (Completable, *http.Response, error)

func (*DefaultApiService) V1ObservedParcelShipmentNumberDelete 

func (a *DefaultApiService) V1ObservedParcelShipmentNumberDelete(ctx context.Context, shipmentNumber string) (Completable, *http.Response, error)

DefaultApiService ParcelApi.removeObservedParcel

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param shipmentNumber ParcelApi.removeObservedParcel.str

@return Completable

func (*DefaultApiService) V1ParcelGet 

func (a *DefaultApiService) V1ParcelGet(ctx context.Context, localVarOptionals *DefaultApiV1ParcelGetOpts) ([]Parcel, *http.Response, error)

func (*DefaultApiService) V1ParcelShipmentNumberGet 

func (a *DefaultApiService) V1ParcelShipmentNumberGet(ctx context.Context, shipmentNumber string) (Parcel, *http.Response, error)

DefaultApiService ParcelApi.oneParcel

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param shipmentNumber ParcelApi.oneParcel.str

@return Parcel

func (*DefaultApiService) V1ParcelsGet 

func (a *DefaultApiService) V1ParcelsGet(ctx context.Context, localVarOptionals *DefaultApiV1ParcelsGetOpts) ([]Parcel, *http.Response, error)

func (*DefaultApiService) V1PointsGet 

func (a *DefaultApiService) V1PointsGet(ctx context.Context, localVarOptionals *DefaultApiV1PointsGetOpts) (DeliveryPointsResponse, *http.Response, error)

func (*DefaultApiService) V1ReturnsTicketsGet 

func (a *DefaultApiService) V1ReturnsTicketsGet(ctx context.Context) (ReturnTicketsResponse, *http.Response, error)

DefaultApiService ReturnTicketApi.m4664a

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ReturnTicketsResponse

func (*DefaultApiService) V1ReturnsTicketsPost 

func (a *DefaultApiService) V1ReturnsTicketsPost(ctx context.Context, localVarOptionals *DefaultApiV1ReturnsTicketsPostOpts) (CreateTicketDetailsNetwork, *http.Response, error)

func (*DefaultApiService) V1ReturnsTicketsUuidGet 

func (a *DefaultApiService) V1ReturnsTicketsUuidGet(ctx context.Context, uuid string) (ReturnTicketNetwork, *http.Response, error)

DefaultApiService ReturnTicketApi.m4663b

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param uuid ReturnTicketApi.m4663b.str

@return ReturnTicketNetwork

func (*DefaultApiService) V1SendSMSCodePhoneNumberGet 

func (a *DefaultApiService) V1SendSMSCodePhoneNumberGet(ctx context.Context, phoneNumber string) (Completable, *http.Response, error)

DefaultApiService RegistrationApi.sendSMSCode

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param phoneNumber RegistrationApi.sendSMSCode.str

@return Completable

func (*DefaultApiService) V2AgreementGet 

func (a *DefaultApiService) V2AgreementGet(ctx context.Context) ([]AgreementGrant, *http.Response, error)

DefaultApiService AgreementApi.agreement

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []AgreementGrant

func (*DefaultApiService) V2AgreementPost 

func (a *DefaultApiService) V2AgreementPost(ctx context.Context, localVarOptionals *DefaultApiV2AgreementPostOpts) (Completable, *http.Response, error)

func (*DefaultApiService) V2CollectCompartmentClaimSessionUuidPost 

func (a *DefaultApiService) V2CollectCompartmentClaimSessionUuidPost(ctx context.Context, sessionUuid string, localVarOptionals *DefaultApiV2CollectCompartmentClaimSessionUuidPostOpts) (CompartmentClaimResponse, *http.Response, error)

func (*DefaultApiService) V2SetPushIdPost 

func (a *DefaultApiService) V2SetPushIdPost(ctx context.Context, localVarOptionals *DefaultApiV2SetPushIdPostOpts) (Completable, *http.Response, error)

type DefaultApiV1AuthenticatePostOpts 

type DefaultApiV1AuthenticatePostOpts struct {
	Body optional.Interface
}

type DefaultApiV1CollectCompartmentStatusSessionUuidGetOpts 

type DefaultApiV1CollectCompartmentStatusSessionUuidGetOpts struct {
	Expected optional.String
}

type DefaultApiV1CollectValidatePostOpts 

type DefaultApiV1CollectValidatePostOpts struct {
	Body optional.Interface
}

type DefaultApiV1ConfirmSMSCodePhoneNumberSmsCodePostOpts 

type DefaultApiV1ConfirmSMSCodePhoneNumberSmsCodePostOpts struct {
	Body optional.Interface
}

type DefaultApiV1NotificationsGetOpts 

type DefaultApiV1NotificationsGetOpts struct {
	From optional.String
}

type DefaultApiV1NotificationsReadAllPostOpts 

type DefaultApiV1NotificationsReadAllPostOpts struct {
	Body optional.Interface
}

type DefaultApiV1ObservedParcelPostOpts 

type DefaultApiV1ObservedParcelPostOpts struct {
	Body optional.Interface
}

type DefaultApiV1ParcelGetOpts 

type DefaultApiV1ParcelGetOpts struct {
	UpdatedAfter optional.String
}

type DefaultApiV1ParcelsGetOpts 

type DefaultApiV1ParcelsGetOpts struct {
	ShipmentNumbers optional.String
}

type DefaultApiV1PointsGetOpts 

type DefaultApiV1PointsGetOpts struct {
	RelativePoint optional.String
	MaxDistance   optional.Float64
	Fields        optional.String
	SortBy        optional.String
	SortOrder     optional.String
	PerPage       optional.Int32
}

type DefaultApiV1ReturnsTicketsPostOpts 

type DefaultApiV1ReturnsTicketsPostOpts struct {
	Body optional.Interface
}

type DefaultApiV2AgreementPostOpts 

type DefaultApiV2AgreementPostOpts struct {
	Body optional.Interface
}

type DefaultApiV2CollectCompartmentClaimSessionUuidPostOpts 

type DefaultApiV2CollectCompartmentClaimSessionUuidPostOpts struct {
	Body optional.Interface
}

type DefaultApiV2SetPushIdPostOpts 

type DefaultApiV2SetPushIdPostOpts struct {
	Body optional.Interface
}

type DeliveryPointData 

type DeliveryPointData struct {
	AddressDetails      *AddressDetails   `json:"addressDetails,omitempty"`
	Location            *PointLocation    `json:"location,omitempty"`
	Location247         bool              `json:"location247,omitempty"`
	LocationDescription string            `json:"locationDescription,omitempty"`
	Name                string            `json:"name,omitempty"`
	OpeningHours        string            `json:"openingHours,omitempty"`
	PaymentType         map[string]string `json:"paymentType,omitempty"`
	Status              string            `json:"status,omitempty"`
	Type_               []string          `json:"type,omitempty"`
	Virtual             int32             `json:"virtual,omitempty"`
}

type DeliveryPointsResponse 

type DeliveryPointsResponse struct {
	Items []DeliveryPointData `json:"items,omitempty"`
}

type GenericSwaggerError 

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GeoPoint 

type GeoPoint struct {
	Accuracy  float64 `json:"accuracy,omitempty"`
	Latitude  float64 `json:"latitude,omitempty"`
	Longitude float64 `json:"longitude,omitempty"`
}

type Location 

type Location struct {
	Column int32  `json:"column,omitempty"`
	Row    int32  `json:"row,omitempty"`
	Side   string `json:"side,omitempty"`
}

type MultiCompartment 

type MultiCompartment struct {
	Collected       bool     `json:"collected,omitempty"`
	Presentation    bool     `json:"presentation,omitempty"`
	ShipmentNumbers []string `json:"shipmentNumbers,omitempty"`
	Uuid            string   `json:"uuid,omitempty"`
}

type NotificationData 

type NotificationData struct {
	Content        string    `json:"content,omitempty"`
	Date           time.Time `json:"date,omitempty"`
	F35560id       string    `json:"f35560id,omitempty"`
	ImageUrl       string    `json:"imageUrl,omitempty"`
	ParcelCount    int32     `json:"parcelCount,omitempty"`
	Read           bool      `json:"read,omitempty"`
	Sender         string    `json:"sender,omitempty"`
	ShipmentNumber string    `json:"shipmentNumber,omitempty"`
	Title          string    `json:"title,omitempty"`
	Type_          string    `json:"type,omitempty"`
}

type NotificationResponse 

type NotificationResponse struct {
	Notifications []NotificationData `json:"notifications,omitempty"`
}

type Parcel 

type Parcel struct {
	CashOnDelivery          *CashOnDelivery    `json:"cashOnDelivery,omitempty"`
	EndOfWeekCollection     bool               `json:"endOfWeekCollection,omitempty"`
	ExpiryDate              time.Time          `json:"expiryDate,omitempty"`
	IsMobileCollectPossible bool               `json:"isMobileCollectPossible,omitempty"`
	IsObserved              bool               `json:"isObserved,omitempty"`
	MultiCompartment        *MultiCompartment  `json:"multiCompartment,omitempty"`
	OpenCode                string             `json:"openCode,omitempty"`
	PhoneNumber             string             `json:"phoneNumber,omitempty"`
	PickupDate              time.Time          `json:"pickupDate,omitempty"`
	PickupPoint             *DeliveryPointData `json:"pickupPoint,omitempty"`
	QrCode                  string             `json:"qrCode,omitempty"`
	ReturnedToSenderDate    time.Time          `json:"returnedToSenderDate,omitempty"`
	SenderName              string             `json:"senderName,omitempty"`
	ShipmentNumber          string             `json:"shipmentNumber,omitempty"`
	ShipmentType            string             `json:"shipmentType,omitempty"`
	Status                  string             `json:"status,omitempty"`
	StatusHistory           []ParcelHistory    `json:"statusHistory,omitempty"`
	StoredDate              time.Time          `json:"storedDate,omitempty"`
}

type ParcelCompartment 

type ParcelCompartment struct {
	OpenCode       string `json:"openCode,omitempty"`
	ShipmentNumber string `json:"shipmentNumber,omitempty"`
}

type ParcelHistory 

type ParcelHistory struct {
	Date   time.Time `json:"date,omitempty"`
	Status string    `json:"status,omitempty"`
}

type PhoneOsRequest 

type PhoneOsRequest struct {
	PhoneOS string `json:"phoneOS,omitempty"`
}

type PointLocation 

type PointLocation struct {
	Latitude  float64 `json:"latitude,omitempty"`
	Longitude float64 `json:"longitude,omitempty"`
}

type PushIdBody 

type PushIdBody struct {
	PushId       string `json:"pushId,omitempty"`
	RefreshToken string `json:"refreshToken,omitempty"`
}

type RefreshTokenResponse 

type RefreshTokenResponse struct {
	AuthToken string `json:"authToken,omitempty"`
}

type ReturnSenderNetwork 

type ReturnSenderNetwork struct {
	Email string `json:"email,omitempty"`
	Name  string `json:"name,omitempty"`
}

type ReturnTicketEventLogNetwork 

type ReturnTicketEventLogNetwork struct {
	Date  time.Time `json:"date,omitempty"`
	Name  string    `json:"name,omitempty"`
	Type_ string    `json:"type,omitempty"`
}

type ReturnTicketNetwork 

type ReturnTicketNetwork struct {
	AcceptedDate     time.Time                      `json:"acceptedDate,omitempty"`
	Address          string                         `json:"address,omitempty"`
	CreatedDate      time.Time                      `json:"createdDate,omitempty"`
	DeliveredDate    time.Time                      `json:"deliveredDate,omitempty"`
	Description      string                         `json:"description,omitempty"`
	EventLog         []ReturnTicketEventLogNetwork  `json:"eventLog,omitempty"`
	ExpiryDate       time.Time                      `json:"expiryDate,omitempty"`
	FormType         string                         `json:"formType,omitempty"`
	Operations       *ReturnTicketOperationsNetwork `json:"operations,omitempty"`
	OrderNumber      string                         `json:"orderNumber,omitempty"`
	OrganizationName string                         `json:"organizationName,omitempty"`
	ParcelSize       string                         `json:"parcelSize,omitempty"`
	QrCode           string                         `json:"qrCode,omitempty"`
	ReturnCode       string                         `json:"returnCode,omitempty"`
	ReturnReason     string                         `json:"returnReason,omitempty"`
	Rma              string                         `json:"rma,omitempty"`
	SentDate         time.Time                      `json:"sentDate,omitempty"`
	ShipmentNumber   string                         `json:"shipmentNumber,omitempty"`
	Status           string                         `json:"status,omitempty"`
	Uuid             string                         `json:"uuid,omitempty"`
}

type ReturnTicketOperationsNetwork 

type ReturnTicketOperationsNetwork struct {
	AutoArchivableSince time.Time `json:"autoArchivableSince,omitempty"`
	Delete              bool      `json:"delete,omitempty"`
	Highlight           bool      `json:"highlight,omitempty"`
	ManualArchive       bool      `json:"manualArchive,omitempty"`
	RefreshUntil        time.Time `json:"refreshUntil,omitempty"`
	Send                bool      `json:"send,omitempty"`
}

type ReturnTicketsResponse 

type ReturnTicketsResponse struct {
	Tickets []ReturnTicketNetwork `json:"tickets,omitempty"`
}

type SubscribeRequest 

type SubscribeRequest struct {
	ShipmentNumber string `json:"shipmentNumber,omitempty"`
}

type ValidationRequest 

type ValidationRequest struct {
	GeoPoint *GeoPoint          `json:"geoPoint,omitempty"`
	Parcel   *ParcelCompartment `json:"parcel,omitempty"`
}

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.