Skip to content

Latest commit

 

History

History
794 lines (516 loc) · 29 KB

DefaultApi.md

File metadata and controls

794 lines (516 loc) · 29 KB

{{classname}}

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

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

V1AuthenticatePost

RefreshTokenResponse V1AuthenticatePost(ctx, optional) RegistrationApi.refreshToken

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1AuthenticatePostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1AuthenticatePostOpts struct

Name Type Description Notes
body optional.Interface of AuthenticateRequest

Return type

RefreshTokenResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectCompartmentCloseSessionUuidGet

CompartmentCloseResponse V1CollectCompartmentCloseSessionUuidGet(ctx, sessionUuid) CompartmentApi.closeCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentApi.closeCompartment.str

Return type

CompartmentCloseResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectCompartmentOpenSessionUuidPost

CompartmentOpenResponse V1CollectCompartmentOpenSessionUuidPost(ctx, sessionUuid) CompartmentApi.openCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentApi.openCompartment.str

Return type

CompartmentOpenResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectCompartmentReopenSessionUuidPost

CompartmentOpenResponse V1CollectCompartmentReopenSessionUuidPost(ctx, sessionUuid) CompartmentApi.reopenCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentApi.reopenCompartment.str

Return type

CompartmentOpenResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectCompartmentStatusSessionUuidGet

CompartmentStatusResponse V1CollectCompartmentStatusSessionUuidGet(ctx, sessionUuid, optional) CompartmentStatusApi.statusCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentStatusApi.statusCompartment.str
optional *DefaultApiV1CollectCompartmentStatusSessionUuidGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1CollectCompartmentStatusSessionUuidGetOpts struct

Name Type Description Notes

expected | optional.String| CompartmentStatusApi.statusCompartment.str2 |

Return type

CompartmentStatusResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectTerminateSessionUuidPost

Completable V1CollectTerminateSessionUuidPost(ctx, sessionUuid) CompartmentApi.terminateCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentApi.terminateCompartment.str

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1CollectValidatePost

CompartmentValidateResponse V1CollectValidatePost(ctx, optional) CompartmentApi.validateCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1CollectValidatePostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1CollectValidatePostOpts struct

Name Type Description Notes
body optional.Interface of ValidationRequest

Return type

CompartmentValidateResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ConfirmSMSCodePhoneNumberSmsCodePost

ConfirmSmsResponse V1ConfirmSMSCodePhoneNumberSmsCodePost(ctx, phoneNumber, smsCode, optional) RegistrationApi.confirmSMSCode

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumber string RegistrationApi.confirmSMSCode.str
smsCode string RegistrationApi.confirmSMSCode.str2
optional *DefaultApiV1ConfirmSMSCodePhoneNumberSmsCodePostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1ConfirmSMSCodePhoneNumberSmsCodePostOpts struct

Name Type Description Notes

body | optional.Interface of PhoneOsRequest| |

Return type

ConfirmSmsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1LogoutPost

Completable V1LogoutPost(ctx, ) UserApi.logout

Required Parameters

This endpoint does not need any parameter.

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1NotificationsGet

NotificationResponse V1NotificationsGet(ctx, optional) NotificationCenterApi.news

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1NotificationsGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1NotificationsGetOpts struct

Name Type Description Notes
from optional.String NotificationCenterApi.news.str

Return type

NotificationResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1NotificationsReadAllPost

NotificationData V1NotificationsReadAllPost(ctx, optional) NotificationCenterApi.markAsReadAll

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1NotificationsReadAllPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1NotificationsReadAllPostOpts struct

Name Type Description Notes
body optional.Interface of time.Time

Return type

NotificationData

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1NotificationsReadNotificationIdPost

NotificationData V1NotificationsReadNotificationIdPost(ctx, notificationId) NotificationCenterApi.markAsRead

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
notificationId string NotificationCenterApi.markAsRead.str

Return type

NotificationData

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ObservedParcelPost

Completable V1ObservedParcelPost(ctx, optional) ParcelApi.subscribeParcel

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1ObservedParcelPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1ObservedParcelPostOpts struct

Name Type Description Notes
body optional.Interface of SubscribeRequest

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ObservedParcelShipmentNumberDelete

Completable V1ObservedParcelShipmentNumberDelete(ctx, shipmentNumber) ParcelApi.removeObservedParcel

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
shipmentNumber string ParcelApi.removeObservedParcel.str

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ParcelGet

[]Parcel V1ParcelGet(ctx, optional) ParcelApi.parcelsWithDate

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1ParcelGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1ParcelGetOpts struct

Name Type Description Notes
updatedAfter optional.String ParcelApi.parcelsWithDate.str

Return type

[]Parcel

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ParcelShipmentNumberGet

Parcel V1ParcelShipmentNumberGet(ctx, shipmentNumber) ParcelApi.oneParcel

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
shipmentNumber string ParcelApi.oneParcel.str

Return type

Parcel

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ParcelsGet

[]Parcel V1ParcelsGet(ctx, optional) ParcelApi.parcels

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1ParcelsGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1ParcelsGetOpts struct

Name Type Description Notes
shipmentNumbers optional.String ParcelApi.parcels.str

Return type

[]Parcel

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1PointsGet

DeliveryPointsResponse V1PointsGet(ctx, optional) MapApi.pointsFor

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1PointsGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1PointsGetOpts struct

Name Type Description Notes
relativePoint optional.String MapApi.pointsFor.str
maxDistance optional.Float64 MapApi.pointsFor.d
fields optional.String MapApi.pointsFor.str2
sortBy optional.String MapApi.pointsFor.str3
sortOrder optional.String MapApi.pointsFor.str4
perPage optional.Int32 MapApi.pointsFor.i

Return type

DeliveryPointsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ReturnsTicketsGet

ReturnTicketsResponse V1ReturnsTicketsGet(ctx, ) ReturnTicketApi.m4664a

Required Parameters

This endpoint does not need any parameter.

Return type

ReturnTicketsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ReturnsTicketsPost

CreateTicketDetailsNetwork V1ReturnsTicketsPost(ctx, optional) CreateTicketApi.m4707b

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV1ReturnsTicketsPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV1ReturnsTicketsPostOpts struct

Name Type Description Notes
body optional.Interface of CreateOrganizationTicketRequest

Return type

CreateTicketDetailsNetwork

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ReturnsTicketsUuidGet

ReturnTicketNetwork V1ReturnsTicketsUuidGet(ctx, uuid) ReturnTicketApi.m4663b

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid string ReturnTicketApi.m4663b.str

Return type

ReturnTicketNetwork

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1SendSMSCodePhoneNumberGet

Completable V1SendSMSCodePhoneNumberGet(ctx, phoneNumber) RegistrationApi.sendSMSCode

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
phoneNumber string RegistrationApi.sendSMSCode.str

Return type

Completable

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2AgreementGet

[]AgreementGrant V2AgreementGet(ctx, ) AgreementApi.agreement

Required Parameters

This endpoint does not need any parameter.

Return type

[]AgreementGrant

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2AgreementPost

Completable V2AgreementPost(ctx, optional) AgreementApi.agreement

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV2AgreementPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV2AgreementPostOpts struct

Name Type Description Notes
body optional.Interface of AgreementGrant

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2CollectCompartmentClaimSessionUuidPost

CompartmentClaimResponse V2CollectCompartmentClaimSessionUuidPost(ctx, sessionUuid, optional) CompartmentApi.claimCompartment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
sessionUuid string CompartmentApi.claimCompartment.str
optional *DefaultApiV2CollectCompartmentClaimSessionUuidPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV2CollectCompartmentClaimSessionUuidPostOpts struct

Name Type Description Notes

body | optional.Interface of CompartmentClaimRequest| |

Return type

CompartmentClaimResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V2SetPushIdPost

Completable V2SetPushIdPost(ctx, optional) CloudMessagingApi.setPushId

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *DefaultApiV2SetPushIdPostOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DefaultApiV2SetPushIdPostOpts struct

Name Type Description Notes
body optional.Interface of PushIdBody

Return type

Completable

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]