api.md

API

V1

Public

Response Types:

• openmev.Apiv1PublicGetOverviewResponse

Methods:

• client.API.V1.Public.GetOverview(ctx context.Context, query openmev.APIV1PublicGetOverviewParams) (openmev.Apiv1PublicGetOverviewResponse, error)

Auctions

Response Types:

• openmev.Apiv1PublicAuctionGetResponse
• openmev.Apiv1PublicAuctionGetHistoryResponse
• openmev.Apiv1PublicAuctionGetLatestResultsResponse

Methods:

• client.API.V1.Public.Auctions.Get(ctx context.Context, id string, query openmev.APIV1PublicAuctionGetParams) (openmev.Apiv1PublicAuctionGetResponse, error)
• client.API.V1.Public.Auctions.GetHistory(ctx context.Context, query openmev.APIV1PublicAuctionGetHistoryParams) (openmev.Apiv1PublicAuctionGetHistoryResponse, error)
• client.API.V1.Public.Auctions.GetLatestResults(ctx context.Context, query openmev.APIV1PublicAuctionGetLatestResultsParams) (openmev.Apiv1PublicAuctionGetLatestResultsResponse, error)

Auctions

Response Types:

• openmev.Apiv1AuctionNewResponse
• openmev.Apiv1AuctionGetResponse
• openmev.Apiv1AuctionListResponse

Methods:

• client.API.V1.Auctions.New(ctx context.Context, body openmev.APIV1AuctionNewParams) (openmev.Apiv1AuctionNewResponse, error)
• client.API.V1.Auctions.Get(ctx context.Context, id string, query openmev.APIV1AuctionGetParams) (openmev.Apiv1AuctionGetResponse, error)
• client.API.V1.Auctions.List(ctx context.Context, query openmev.APIV1AuctionListParams) (openmev.Apiv1AuctionListResponse, error)

Bids

Response Types:

• openmev.Apiv1AuctionBidNewResponse
• openmev.Apiv1AuctionBidAsyncResponse

Methods:

• client.API.V1.Auctions.Bids.New(ctx context.Context, id string, body openmev.APIV1AuctionBidNewParams) (openmev.Apiv1AuctionBidNewResponse, error)
• client.API.V1.Auctions.Bids.Async(ctx context.Context, id string, body openmev.APIV1AuctionBidAsyncParams) (openmev.Apiv1AuctionBidAsyncResponse, error)

Bids

Response Types:

• openmev.Apiv1BidGetStatusResponse

Methods:

• client.API.V1.Bids.GetStatus(ctx context.Context, trackingID string, query openmev.APIV1BidGetStatusParams) (openmev.Apiv1BidGetStatusResponse, error)

Auth

Response Types:

• openmev.Apiv1AuthGetResponse
• openmev.Apiv1AuthGetValidateResponse

Methods:

• client.API.V1.Auth.Get(ctx context.Context, code string) (openmev.Apiv1AuthGetResponse, error)
• client.API.V1.Auth.GetValidate(ctx context.Context, query openmev.APIV1AuthGetValidateParams) (openmev.Apiv1AuthGetValidateResponse, error)

APIKeys

Response Types:

• openmev.Apiv1AuthAPIKeyAPIKeysResponse
• openmev.Apiv1AuthAPIKeyGetAPIKeysResponse

Methods:

• client.API.V1.Auth.APIKeys.APIKeys(ctx context.Context, body openmev.APIV1AuthAPIKeyAPIKeysParams) (openmev.Apiv1AuthAPIKeyAPIKeysResponse, error)
• client.API.V1.Auth.APIKeys.GetAPIKeys(ctx context.Context, query openmev.APIV1AuthAPIKeyGetAPIKeysParams) (openmev.Apiv1AuthAPIKeyGetAPIKeysResponse, error)

Register

Response Types:

• openmev.Apiv1AuthRegisterMemberResponse
• openmev.Apiv1AuthRegisterOrganizationResponse

Methods:

• client.API.V1.Auth.Register.Member(ctx context.Context, body openmev.APIV1AuthRegisterMemberParams) (openmev.Apiv1AuthRegisterMemberResponse, error)
• client.API.V1.Auth.Register.Organization(ctx context.Context, body openmev.APIV1AuthRegisterOrganizationParams) (openmev.Apiv1AuthRegisterOrganizationResponse, error)

Scheduler

Response Types:

• openmev.Apiv1SchedulerGetStatusResponse
• openmev.Apiv1SchedulerTriggerResponse

Methods:

• client.API.V1.Scheduler.GetStatus(ctx context.Context) (openmev.Apiv1SchedulerGetStatusResponse, error)
• client.API.V1.Scheduler.Trigger(ctx context.Context) (openmev.Apiv1SchedulerTriggerResponse, error)

Users

Response Types:

• openmev.Apiv1UserGetResponse
• openmev.Apiv1UserUpdateResponse
• openmev.Apiv1UserListResponse
• openmev.Apiv1UserGetMeResponse

Methods:

• client.API.V1.Users.Get(ctx context.Context, publicID string) (openmev.Apiv1UserGetResponse, error)
• client.API.V1.Users.Update(ctx context.Context, id string, body openmev.APIV1UserUpdateParams) (openmev.Apiv1UserUpdateResponse, error)
• client.API.V1.Users.List(ctx context.Context, query openmev.APIV1UserListParams) (openmev.Apiv1UserListResponse, error)
• client.API.V1.Users.GetMe(ctx context.Context) (openmev.Apiv1UserGetMeResponse, error)

Organizations

Response Types:

• openmev.Apiv1OrganizationGetResponse
• openmev.Apiv1OrganizationUpdateResponse
• openmev.Apiv1OrganizationListResponse
• openmev.Apiv1OrganizationInvitesResponse

Methods:

• client.API.V1.Organizations.Get(ctx context.Context, publicID string) (openmev.Apiv1OrganizationGetResponse, error)
• client.API.V1.Organizations.Update(ctx context.Context, id string, body openmev.APIV1OrganizationUpdateParams) (openmev.Apiv1OrganizationUpdateResponse, error)
• client.API.V1.Organizations.List(ctx context.Context, query openmev.APIV1OrganizationListParams) (openmev.Apiv1OrganizationListResponse, error)
• client.API.V1.Organizations.Invites(ctx context.Context, id string, body openmev.APIV1OrganizationInvitesParams) (openmev.Apiv1OrganizationInvitesResponse, error)

Members

Response Types:

• openmev.Apiv1OrganizationMemberListResponse
• openmev.Apiv1OrganizationMemberDeleteResponse

Methods:

• client.API.V1.Organizations.Members.List(ctx context.Context, orgID string, query openmev.APIV1OrganizationMemberListParams) (openmev.Apiv1OrganizationMemberListResponse, error)
• client.API.V1.Organizations.Members.Delete(ctx context.Context, userID string, body openmev.APIV1OrganizationMemberDeleteParams) (openmev.Apiv1OrganizationMemberDeleteResponse, error)

Invites

Response Types:

• openmev.Apiv1InviteGetResponse
• openmev.Apiv1InviteListResponse
• openmev.Apiv1InviteDeleteResponse

Methods:

• client.API.V1.Invites.Get(ctx context.Context, code string) (openmev.Apiv1InviteGetResponse, error)
• client.API.V1.Invites.List(ctx context.Context, query openmev.APIV1InviteListParams) (openmev.Apiv1InviteListResponse, error)
• client.API.V1.Invites.Delete(ctx context.Context, code string) (openmev.Apiv1InviteDeleteResponse, error)

Analytics

Response Types:

• openmev.Apiv1AnalyticsGetResponse
• openmev.Apiv1AnalyticsGetLeaderboardResponse
• openmev.Apiv1AnalyticsGetSystemResponse

Methods:

• client.API.V1.Analytics.Get(ctx context.Context, id string, query openmev.APIV1AnalyticsGetParams) (openmev.Apiv1AnalyticsGetResponse, error)
• client.API.V1.Analytics.GetLeaderboard(ctx context.Context, query openmev.APIV1AnalyticsGetLeaderboardParams) (openmev.Apiv1AnalyticsGetLeaderboardResponse, error)
• client.API.V1.Analytics.GetSystem(ctx context.Context, query openmev.APIV1AnalyticsGetSystemParams) (openmev.Apiv1AnalyticsGetSystemResponse, error)

Users

Response Types:

• openmev.Apiv1AnalyticsUserGetMeResponse

Methods:

• client.API.V1.Analytics.Users.GetMe(ctx context.Context, query openmev.APIV1AnalyticsUserGetMeParams) (openmev.Apiv1AnalyticsUserGetMeResponse, error)

Health

Response Types:

• openmev.HealthCheckResponse
• openmev.HealthCheckDetailedResponse

Methods:

• client.Health.Check(ctx context.Context) (openmev.HealthCheckResponse, error)
• client.Health.CheckDetailed(ctx context.Context) (openmev.HealthCheckDetailedResponse, error)