Function FeedsApiFp

FeedsApi - functional programming interface

Export

  • FeedsApiFp(
        configuration?: Configuration,
    ): {
        cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >;
        createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >;
        getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>,
        >;
        getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<FeedDocument>,
        >;
        getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >;
        createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >;
        getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>,
        >;
        getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<FeedDocument>,
        >;
        getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >;
    }

    • cancelFeed:function
      • cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • feedId: string

          The identifier for the feed. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • createFeed:function
      • createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >

      • Creates a feed. Upload the contents of the feed document before calling this operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API. The rate limit for the JSON_LISTINGS_FEED feed type differs from the rate limit for the createFeed operation. For more information, refer to the Building Listings Management Workflows Guide.

        Parameters

        • body: CreateFeedSpecification

          Information required to create the feed.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >

        Throws

    • createFeedDocument:function
      • createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >

      • Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • body: CreateFeedDocumentSpecification

          Specifies the content type for the createFeedDocument operation.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >

        Throws

    • getFeed:function
      • getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>>

      • Returns feed details (including the resultDocumentId, if available) for the feed that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • feedId: string

          The identifier for the feed. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Feed>>

        Throws

    • getFeedDocument:function
      • getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>,
        >

      • Returns the information required for retrieving a feed document's contents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • feedDocumentId: string

          The identifier of the feed document.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<FeedDocument>,
        >

        Throws

    • getFeeds:function
      • getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >

      • Returns feed details for the feeds that match the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • OptionalfeedTypes: string[]

          A list of feed types used to filter feeds. When feedTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either feedTypes or nextToken is required.

        • OptionalmarketplaceIds: string[]

          A list of marketplace identifiers used to filter feeds. The feeds returned will match at least one of the marketplaces that you specify.

        • OptionalpageSize: number

          The maximum number of feeds to return in a single call.

        • OptionalprocessingStatuses: GetFeedsProcessingStatusesEnum[]

          A list of processing statuses used to filter feeds.

        • OptionalcreatedSince: string

          The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

        • OptionalcreatedUntil: string

          The latest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is now.

        • OptionalnextToken: string

          A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getFeeds operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >

        Throws

Settings

Member Visibility