Categorygithub.com/getapihub/golang-sdk
modulepackage
0.0.6
Repository: https://github.com/getapihub/golang-sdk.git
Documentation: pkg.go.dev

# README

GetAPIHub Golang SDK

This is the official Golang SDK for the APIHub API. This SDK provides a convenient way to interact with the APIHub API from your Golang application.

Installation

To install the SDK, run the following command:

go get github.com/getapihub/sdk-go

Usage

Client initialisation:

package main

import (
	apihubsdk "github.com/getapihub/golang-sdk"
	"github.com/oapi-codegen/oapi-codegen/v2/pkg/securityprovider"
)

func main() {
	xApiKeyAuth, err := securityprovider.NewSecurityProviderApiKey("header", "X-API-Key", "{API_KEY}")
	if err != nil {
		log.Fatal(err)
	}
	client, err := apihubsdk.NewClientWithResponses("https://gateway.getapihub.cloud", apihubsdk.WithRequestEditorFn(xApiKeyAuth.Intercept))
	if err != nil {
		panic(err)
	}

	profile, err = client.GetV2ProfileWithResponse(context.Background(), &apihubsdk.GetV2ProfileParams{
		LiProfileUrl: "https://www.linkedin.com/in/username/",
	})
}

# Functions

Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewGetCompanyRequest generates requests for GetCompany.
NewGetJobsDetailsRequest generates requests for GetJobsDetails.
NewGetJobsSearchRequest generates requests for GetJobsSearch.
NewGetPostCommentsRequest generates requests for GetPostComments.
NewGetProfilePostsRequest generates requests for GetProfilePosts.
NewGetProfileRecommendationsGivenRequest generates requests for GetProfileRecommendationsGiven.
NewGetProfileRecommendationsReceivedRequest generates requests for GetProfileRecommendationsReceived.
NewGetProfileRequest generates requests for GetProfile.
NewGetProfileSearchRequest generates requests for GetProfileSearch.
NewGetV2CompanyInsightsRequest generates requests for GetV2CompanyInsights.
NewGetV2CompanyPostsRequest generates requests for GetV2CompanyPosts.
NewGetV2CompanyRequest generates requests for GetV2Company.
NewGetV2JobsDetailsRequest generates requests for GetV2JobsDetails.
NewGetV2JobsHiringteamRequest generates requests for GetV2JobsHiringteam.
NewGetV2JobsSearchRequest generates requests for GetV2JobsSearch.
NewGetV2PostCommentsRequest generates requests for GetV2PostComments.
NewGetV2PostReactionsRequest generates requests for GetV2PostReactions.
NewGetV2ProfilePostsRequest generates requests for GetV2ProfilePosts.
NewGetV2ProfileRecommendationsGivenRequest generates requests for GetV2ProfileRecommendationsGiven.
NewGetV2ProfileRecommendationsReceivedRequest generates requests for GetV2ProfileRecommendationsReceived.
NewGetV2ProfileRequest generates requests for GetV2Profile.
NewGetV2ProfileSearchRequest generates requests for GetV2ProfileSearch.
ParseGetCompanyResponse parses an HTTP response from a GetCompanyWithResponse call.
ParseGetJobsDetailsResponse parses an HTTP response from a GetJobsDetailsWithResponse call.
ParseGetJobsSearchResponse parses an HTTP response from a GetJobsSearchWithResponse call.
ParseGetPostCommentsResponse parses an HTTP response from a GetPostCommentsWithResponse call.
ParseGetProfilePostsResponse parses an HTTP response from a GetProfilePostsWithResponse call.
ParseGetProfileRecommendationsGivenResponse parses an HTTP response from a GetProfileRecommendationsGivenWithResponse call.
ParseGetProfileRecommendationsReceivedResponse parses an HTTP response from a GetProfileRecommendationsReceivedWithResponse call.
ParseGetProfileResponse parses an HTTP response from a GetProfileWithResponse call.
ParseGetProfileSearchResponse parses an HTTP response from a GetProfileSearchWithResponse call.
ParseGetV2CompanyInsightsResponse parses an HTTP response from a GetV2CompanyInsightsWithResponse call.
ParseGetV2CompanyPostsResponse parses an HTTP response from a GetV2CompanyPostsWithResponse call.
ParseGetV2CompanyResponse parses an HTTP response from a GetV2CompanyWithResponse call.
ParseGetV2JobsDetailsResponse parses an HTTP response from a GetV2JobsDetailsWithResponse call.
ParseGetV2JobsHiringteamResponse parses an HTTP response from a GetV2JobsHiringteamWithResponse call.
ParseGetV2JobsSearchResponse parses an HTTP response from a GetV2JobsSearchWithResponse call.
ParseGetV2PostCommentsResponse parses an HTTP response from a GetV2PostCommentsWithResponse call.
ParseGetV2PostReactionsResponse parses an HTTP response from a GetV2PostReactionsWithResponse call.
ParseGetV2ProfilePostsResponse parses an HTTP response from a GetV2ProfilePostsWithResponse call.
ParseGetV2ProfileRecommendationsGivenResponse parses an HTTP response from a GetV2ProfileRecommendationsGivenWithResponse call.
ParseGetV2ProfileRecommendationsReceivedResponse parses an HTTP response from a GetV2ProfileRecommendationsReceivedWithResponse call.
ParseGetV2ProfileResponse parses an HTTP response from a GetV2ProfileWithResponse call.
ParseGetV2ProfileSearchResponse parses an HTTP response from a GetV2ProfileSearchWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

No description provided by the author
Defines values for GetJobsSearchParamsDatePosted.
Defines values for GetJobsSearchParamsDatePosted.
Defines values for GetJobsSearchParamsDatePosted.
Defines values for GetJobsSearchParamsDatePosted.
Defines values for GetJobsSearchParamsJobType.
Defines values for GetJobsSearchParamsJobType.
Defines values for GetJobsSearchParamsJobType.
Defines values for GetJobsSearchParamsJobType.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSalary.
Defines values for GetJobsSearchParamsSort.
Defines values for GetJobsSearchParamsSort.
Defines values for GetV2JobsSearchParamsDatePosted.
Defines values for GetV2JobsSearchParamsDatePosted.
Defines values for GetV2JobsSearchParamsDatePosted.
Defines values for GetV2JobsSearchParamsDatePosted.
Defines values for GetV2JobsSearchParamsJobType.
Defines values for GetV2JobsSearchParamsJobType.
Defines values for GetV2JobsSearchParamsJobType.
Defines values for GetV2JobsSearchParamsJobType.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSalary.
Defines values for GetV2JobsSearchParamsSort.
Defines values for GetV2JobsSearchParamsSort.

# Structs

Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CommonresponsesCompanyDetails defines model for commonresponses.CompanyDetails.
CommonresponsesCompanyDetailsData defines model for commonresponses.CompanyDetailsData.
CommonresponsesContentLanguage defines model for commonresponses.ContentLanguage.
CommonresponsesGetProfilePostsResult defines model for commonresponses.GetProfilePostsResult.
CommonresponsesGetProfileResult defines model for commonresponses.GetProfileResult.
CommonresponsesJobApplyMethod defines model for commonresponses.JobApplyMethod.
CommonresponsesJobCompany defines model for commonresponses.JobCompany.
CommonresponsesJobDetailsCompany defines model for commonresponses.JobDetailsCompany.
CommonresponsesJobDetailsData defines model for commonresponses.JobDetailsData.
CommonresponsesJobItem defines model for commonresponses.JobItem.
CommonresponsesJobListResponse defines model for commonresponses.JobListResponse.
CommonresponsesPeopleSearchResponse defines model for commonresponses.PeopleSearchResponse.
CommonresponsesPostComments defines model for commonresponses.PostComments.
CommonresponsesRecommendationsGiven defines model for commonresponses.RecommendationsGiven.
CommonresponsesRecommendationsReceived defines model for commonresponses.RecommendationsReceived.
GetCompanyParams defines parameters for GetCompany.
No description provided by the author
GetJobsDetailsParams defines parameters for GetJobsDetails.
No description provided by the author
GetJobsSearchParams defines parameters for GetJobsSearch.
No description provided by the author
GetPostCommentsParams defines parameters for GetPostComments.
No description provided by the author
GetProfileParams defines parameters for GetProfile.
GetProfilePostsParams defines parameters for GetProfilePosts.
No description provided by the author
GetProfileRecommendationsGivenParams defines parameters for GetProfileRecommendationsGiven.
No description provided by the author
GetProfileRecommendationsReceivedParams defines parameters for GetProfileRecommendationsReceived.
No description provided by the author
No description provided by the author
GetProfileSearchParams defines parameters for GetProfileSearch.
No description provided by the author
GetV2CompanyInsightsParams defines parameters for GetV2CompanyInsights.
No description provided by the author
GetV2CompanyParams defines parameters for GetV2Company.
GetV2CompanyPostsParams defines parameters for GetV2CompanyPosts.
No description provided by the author
No description provided by the author
GetV2JobsDetailsParams defines parameters for GetV2JobsDetails.
No description provided by the author
GetV2JobsHiringteamParams defines parameters for GetV2JobsHiringteam.
No description provided by the author
GetV2JobsSearchParams defines parameters for GetV2JobsSearch.
No description provided by the author
GetV2PostCommentsParams defines parameters for GetV2PostComments.
No description provided by the author
GetV2PostReactionsParams defines parameters for GetV2PostReactions.
No description provided by the author
GetV2ProfileParams defines parameters for GetV2Profile.
GetV2ProfilePostsParams defines parameters for GetV2ProfilePosts.
No description provided by the author
GetV2ProfileRecommendationsGivenParams defines parameters for GetV2ProfileRecommendationsGiven.
No description provided by the author
GetV2ProfileRecommendationsReceivedParams defines parameters for GetV2ProfileRecommendationsReceived.
No description provided by the author
No description provided by the author
GetV2ProfileSearchParams defines parameters for GetV2ProfileSearch.
No description provided by the author
ResponsesAlumni defines model for responses.Alumni.
ResponsesAlumniProfile defines model for responses.AlumniProfile.
ResponsesAnnouncedOn defines model for responses.AnnouncedOn.
ResponsesBackgroundCover defines model for responses.BackgroundCover.
ResponsesCallToAction defines model for responses.CallToAction.
ResponsesCallToActionMessage defines model for responses.CallToActionMessage.
ResponsesComment defines model for responses.Comment.
ResponsesCommentAuthor defines model for responses.CommentAuthor.
ResponsesCompanyDetailsResponseV2 defines model for responses.CompanyDetailsResponseV2.
ResponsesCompanyHiresCount defines model for responses.CompanyHiresCount.
ResponsesCompanyInfo defines model for responses.CompanyInfo.
ResponsesCompanyInsightsAlumni defines model for responses.CompanyInsightsAlumni.
ResponsesCompanyInsightsHeadcount defines model for responses.CompanyInsightsHeadcount.
ResponsesCompanyInsightsHeadcountFunction defines model for responses.CompanyInsightsHeadcountFunction.
ResponsesCompanyInsightsHires defines model for responses.CompanyInsightsHires.
ResponsesCompanyInsightsJobOpenings defines model for responses.CompanyInsightsJobOpenings.
ResponsesCompanyInsightsV2 defines model for responses.CompanyInsightsV2.
ResponsesCompanyInsightsV2Response defines model for responses.CompanyInsightsV2Response.
ResponsesCompanyPicture defines model for responses.CompanyPicture.
ResponsesCompanyPost defines model for responses.CompanyPost.
ResponsesCompanyPostArticle defines model for responses.CompanyPostArticle.
ResponsesCompanyPostAuthor defines model for responses.CompanyPostAuthor.
ResponsesCompanyPostImage defines model for responses.CompanyPostImage.
ResponsesCompanyPostVideo defines model for responses.CompanyPostVideo.
ResponsesCompanySeniorHires defines model for responses.CompanySeniorHires.
ResponsesContentLanguage defines model for responses.ContentLanguage.
ResponsesDate defines model for responses.Date.
ResponsesFounded defines model for responses.Founded.
ResponsesFunding defines model for responses.Funding.
ResponsesGetCompanyPostsResultV2 defines model for responses.GetCompanyPostsResultV2.
ResponsesGetProfilePostsResultV2 defines model for responses.GetProfilePostsResultV2.
ResponsesGrowthPeriod defines model for responses.GrowthPeriod.
ResponsesHeadcountByFunction defines model for responses.HeadcountByFunction.
ResponsesHeadcountGrowth defines model for responses.HeadcountGrowth.
ResponsesHeadcountGrowthByFunction defines model for responses.HeadcountGrowthByFunction.
ResponsesHeadcountGrowthPeriod defines model for responses.HeadcountGrowthPeriod.
ResponsesHeadquarter defines model for responses.Headquarter.
ResponsesHiredProfile defines model for responses.HiredProfile.
ResponsesJobApplyMethod defines model for responses.JobApplyMethod.
ResponsesJobCompany defines model for responses.JobCompany.
ResponsesJobCompanyHeadQuarter defines model for responses.JobCompanyHeadQuarter.
ResponsesJobDetailsCompany defines model for responses.JobDetailsCompany.
ResponsesJobDetailsResponseV2 defines model for responses.JobDetailsResponseV2.
ResponsesJobHiringTeamProfilePicture defines model for responses.JobHiringTeamProfilePicture.
ResponsesJobHiringTeamResponseV2 defines model for responses.JobHiringTeamResponseV2.
ResponsesJobHiringTeamV2 defines model for responses.JobHiringTeamV2.
ResponsesJobItem defines model for responses.JobItem.
ResponsesJobListResponseV2 defines model for responses.JobListResponseV2.
ResponsesJobOpeningCountFunction defines model for responses.JobOpeningCountFunction.
ResponsesJobOpeningFunction defines model for responses.JobOpeningFunction.
ResponsesJobOpeningGrowthFunction defines model for responses.JobOpeningGrowthFunction.
ResponsesJobOpeningsGrowthByFunction defines model for responses.JobOpeningsGrowthByFunction.
ResponsesLastFundingRound defines model for responses.LastFundingRound.
ResponsesLatestHeadcountByFunction defines model for responses.LatestHeadcountByFunction.
ResponsesLeadInvestor defines model for responses.LeadInvestor.
ResponsesLocation defines model for responses.Location.
ResponsesLogo defines model for responses.Logo.
ResponsesMoneyRaised defines model for responses.MoneyRaised.
ResponsesPeople defines model for responses.People.
ResponsesPeopleSearchResponseV2 defines model for responses.PeopleSearchResponseV2.
ResponsesPostCommentsV2 defines model for responses.PostCommentsV2.
ResponsesPostReactionsV2 defines model for responses.PostReactionsV2.
ResponsesProfileAudience defines model for responses.ProfileAudience.
ResponsesProfileCourse defines model for responses.ProfileCourse.
ResponsesProfileEducationV2 defines model for responses.ProfileEducationV2.
ResponsesProfileExperienceV2 defines model for responses.ProfileExperienceV2.
ResponsesProfileLanguage defines model for responses.ProfileLanguage.
ResponsesProfileLocation defines model for responses.ProfileLocation.
ResponsesProfilePicture defines model for responses.ProfilePicture.
ResponsesProfilePost defines model for responses.ProfilePost.
ResponsesProfilePostArticle defines model for responses.ProfilePostArticle.
ResponsesProfilePostAuthor defines model for responses.ProfilePostAuthor.
ResponsesProfilePostAuthorCompany defines model for responses.ProfilePostAuthorCompany.
ResponsesProfilePostImage defines model for responses.ProfilePostImage.
ResponsesProfilePostReShared defines model for responses.ProfilePostReShared.
ResponsesProfileResponseV2 defines model for responses.ProfileResponseV2.
ResponsesProfileSkill defines model for responses.ProfileSkill.
ResponsesProfilPostVideo defines model for responses.ProfilPostVideo.
ResponsesReaction defines model for responses.Reaction.
ResponsesRecommendationGiven defines model for responses.RecommendationGiven.
ResponsesRecommendationReceived defines model for responses.RecommendationReceived.
ResponsesRecommendationsGivenV2 defines model for responses.RecommendationsGivenV2.
ResponsesRecommendationsReceivedV2 defines model for responses.RecommendationsReceivedV2.
ResponsesStaffCountRange defines model for responses.StaffCountRange.
ResponsesUser defines model for responses.User.
UtilsLinkedInDateObj defines model for utils.LinkedInDateObj.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

ClientOption allows setting custom parameters during construction.
GetJobsSearchParamsDatePosted defines parameters for GetJobsSearch.
GetJobsSearchParamsJobType defines parameters for GetJobsSearch.
GetJobsSearchParamsSalary defines parameters for GetJobsSearch.
GetJobsSearchParamsSort defines parameters for GetJobsSearch.
GetV2JobsSearchParamsDatePosted defines parameters for GetV2JobsSearch.
GetV2JobsSearchParamsJobType defines parameters for GetV2JobsSearch.
GetV2JobsSearchParamsSalary defines parameters for GetV2JobsSearch.
GetV2JobsSearchParamsSort defines parameters for GetV2JobsSearch.
RequestEditorFn is the function signature for the RequestEditor callback function.