client

package
v0.1.5 Latest Latest
Warning

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

 Go to latest Published: Nov 14, 2022 License: Apache-2.0 Imports: 7 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 {
	Client   *http.Client
	Endpoint string
}

Client for service smapi version v0.

func (*Client) AssociateCatalogWithSkillV0 

func (s *Client) AssociateCatalogWithSkillV0(skillId string, catalogId string) (err error)

AssociateCatalogWithSkillV0 Associate skill with catalog. 

skillId - The skill ID.
catalogId - Provides a unique identifier of the catalog

func (*Client) CompleteCatalogUploadV0 

func (s *Client) CompleteCatalogUploadV0(catalogId string, uploadId string, completeUploadRequestPayload *upload_.CompleteUploadRequest) (err error)

CompleteCatalogUploadV0 Completes an upload. To be called after the file is uploaded to the backend data store using presigned url(s). 

catalogId - Provides a unique identifier of the catalog
uploadId - Unique identifier of the upload
completeUploadRequestPayload - Request payload to complete an upload.

func (*Client) CreateCatalogV0 

func (s *Client) CreateCatalogV0(createCatalogRequest *catalog_.CreateCatalogRequest) (response *catalog_.CatalogDetails, err error)

CreateCatalogV0 Creates a new catalog based on information provided in the request. 

createCatalogRequest - Defines the request body for createCatalog API.

func (*Client) CreateContentUploadV0 

func (s *Client) CreateContentUploadV0(catalogId string, createContentUploadRequest *upload_.CreateContentUploadRequest) (response *upload_.CreateContentUploadResponse, err error)

CreateContentUploadV0 Creates a new upload for a catalog and returns presigned upload parts for uploading the file. 

catalogId - Provides a unique identifier of the catalog
createContentUploadRequest - Defines the request body for updateCatalog API.

func (*Client) CreateSubscriberForDevelopmentEventsV0 

func (s *Client) CreateSubscriberForDevelopmentEventsV0(createSubscriberRequest *subscriber_.CreateSubscriberRequest) (err error)

CreateSubscriberForDevelopmentEventsV0 Creates a new subscriber resource for a vendor. 

createSubscriberRequest - Defines the request body for createSubscriber API.

func (*Client) CreateSubscriptionForDevelopmentEventsV0 

func (s *Client) CreateSubscriptionForDevelopmentEventsV0(createSubscriptionRequest *subscription_.CreateSubscriptionRequest) (err error)

CreateSubscriptionForDevelopmentEventsV0 Creates a new subscription for a subscriber. This needs to be authorized by the client/vendor who created the subscriber and the vendor who publishes the event. 

createSubscriptionRequest - Request body for createSubscription API.

func (*Client) DeleteSubscriberForDevelopmentEventsV0 

func (s *Client) DeleteSubscriberForDevelopmentEventsV0(subscriberId string) (err error)

DeleteSubscriberForDevelopmentEventsV0 Deletes a specified subscriber. 

subscriberId - Unique identifier of the subscriber.

func (*Client) DeleteSubscriptionForDevelopmentEventsV0 

func (s *Client) DeleteSubscriptionForDevelopmentEventsV0(subscriptionId string) (err error)

DeleteSubscriptionForDevelopmentEventsV0 Deletes a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can delete this resource with appropriate authorization. 

subscriptionId - Unique identifier of the subscription.

func (*Client) GetCatalogV0 

func (s *Client) GetCatalogV0(catalogId string) (response *catalog_.CatalogDetails, err error)

GetCatalogV0 Returns information about a particular catalog. 

catalogId - Provides a unique identifier of the catalog

func (*Client) GetContentUploadByIdV0 

func (s *Client) GetContentUploadByIdV0(catalogId string, uploadId string) (response *upload_.GetContentUploadResponse, err error)

GetContentUploadByIdV0 Gets detailed information about an upload which was created for a specific catalog. Includes the upload's ingestion steps and a presigned url for downloading the file. 

catalogId - Provides a unique identifier of the catalog
uploadId - Unique identifier of the upload

func (*Client) GetSubscriberForDevelopmentEventsV0 

func (s *Client) GetSubscriberForDevelopmentEventsV0(subscriberId string) (response *subscriber_.SubscriberInfo, err error)

GetSubscriberForDevelopmentEventsV0 Returns information about specified subscriber. 

subscriberId - Unique identifier of the subscriber.

func (*Client) GetSubscriptionForDevelopmentEventsV0 

func (s *Client) GetSubscriptionForDevelopmentEventsV0(subscriptionId string) (response *subscription_.SubscriptionInfo, err error)

GetSubscriptionForDevelopmentEventsV0 Returns information about a particular subscription. Both, the vendor who created the subscriber and the vendor who publishes the event can retrieve this resource with appropriate authorization. 

subscriptionId - Unique identifier of the subscription.

func (*Client) ListCatalogsForSkillV0 

func (s *Client) ListCatalogsForSkillV0(nextToken string, maxResults int, skillId string) (response *catalog_.ListCatalogsResponse, err error)

ListCatalogsForSkillV0 Lists all the catalogs associated with a skill. 

nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.
maxResults - Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
skillId - The skill ID.

func (*Client) ListCatalogsForVendorV0 

func (s *Client) ListCatalogsForVendorV0(nextToken string, maxResults int, vendorId string) (response *catalog_.ListCatalogsResponse, err error)

ListCatalogsForVendorV0 Lists catalogs associated with a vendor. 

nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.
maxResults - Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
vendorId - The vendor ID.

func (*Client) ListSubscribersForDevelopmentEventsV0 

func (s *Client) ListSubscribersForDevelopmentEventsV0(vendorId string, nextToken string, maxResults int) (response *subscriber_.ListSubscribersResponse, err error)

ListSubscribersForDevelopmentEventsV0 Lists the subscribers for a particular vendor. 

vendorId - The vendor ID.
nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.
maxResults - Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.

func (*Client) ListSubscriptionsForDevelopmentEventsV0 

func (s *Client) ListSubscriptionsForDevelopmentEventsV0(vendorId string, nextToken string, maxResults int, subscriberId string) (response *subscription_.ListSubscriptionsResponse, err error)

ListSubscriptionsForDevelopmentEventsV0 Lists all the subscriptions for a vendor/subscriber depending on the query parameter. 

vendorId - The vendor ID.
nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.
maxResults - Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
subscriberId - Unique identifier of the subscriber. If this query parameter is provided, the list would be filtered by the owning subscriberId.

func (*Client) ListUploadsForCatalogV0 

func (s *Client) ListUploadsForCatalogV0(nextToken string, maxResults int, catalogId string) (response *upload_.ListUploadsResponse, err error)

ListUploadsForCatalogV0 Lists all the uploads for a particular catalog. 

nextToken - When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element. The value of nextToken can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that Skill Management API understands. Token has expiry of 24 hours.
maxResults - Sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 50 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned, the response contains isTruncated = true.
catalogId - Provides a unique identifier of the catalog

func (*Client) SetSubscriberForDevelopmentEventsV0 

func (s *Client) SetSubscriberForDevelopmentEventsV0(subscriberId string, updateSubscriberRequest *subscriber_.UpdateSubscriberRequest) (err error)

SetSubscriberForDevelopmentEventsV0 Updates the properties of a subscriber. 

subscriberId - Unique identifier of the subscriber.
updateSubscriberRequest - Defines the request body for updateSubscriber API.

func (*Client) SetSubscriptionForDevelopmentEventsV0 

func (s *Client) SetSubscriptionForDevelopmentEventsV0(subscriptionId string, updateSubscriptionRequest *subscription_.UpdateSubscriptionRequest) (err error)

SetSubscriptionForDevelopmentEventsV0 Updates the mutable properties of a subscription. This needs to be authorized by the client/vendor who created the subscriber and the vendor who publishes the event. The subscriberId cannot be updated. 

subscriptionId - Unique identifier of the subscription.
updateSubscriptionRequest - Request body for updateSubscription API.

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.