Function AplusContentApiAxiosParamCreator

AplusContentApi - axios parameter creator

Export

  • AplusContentApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        createContentDocument: (
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getContentDocument: (
            contentReferenceKey: string,
            marketplaceId: string,
            includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        listContentDocumentAsinRelations: (
            contentReferenceKey: string,
            marketplaceId: string,
            includedDataSet?: Set<"METADATA">,
            asinSet?: Set<string>,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentApprovalSubmission: (
            contentReferenceKey: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentAsinRelations: (
            contentReferenceKey: string,
            marketplaceId: string,
            postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentSuspendSubmission: (
            contentReferenceKey: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        searchContentDocuments: (
            marketplaceId: string,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        searchContentPublishRecords: (
            marketplaceId: string,
            asin: string,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateContentDocument: (
            contentReferenceKey: string,
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        validateContentDocumentAsinRelations: (
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            asinSet?: Set<string>,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        createContentDocument: (
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getContentDocument: (
            contentReferenceKey: string,
            marketplaceId: string,
            includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        listContentDocumentAsinRelations: (
            contentReferenceKey: string,
            marketplaceId: string,
            includedDataSet?: Set<"METADATA">,
            asinSet?: Set<string>,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentApprovalSubmission: (
            contentReferenceKey: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentAsinRelations: (
            contentReferenceKey: string,
            marketplaceId: string,
            postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        postContentDocumentSuspendSubmission: (
            contentReferenceKey: string,
            marketplaceId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        searchContentDocuments: (
            marketplaceId: string,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        searchContentPublishRecords: (
            marketplaceId: string,
            asin: string,
            pageToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateContentDocument: (
            contentReferenceKey: string,
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        validateContentDocumentAsinRelations: (
            marketplaceId: string,
            postContentDocumentRequest: PostContentDocumentRequest,
            asinSet?: Set<string>,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • createContentDocument: (
          marketplaceId: string,
          postContentDocumentRequest: PostContentDocumentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates a new A+ Content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • getContentDocument: (
          contentReferenceKey: string,
          marketplaceId: string,
          includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns an A+ Content document, if available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • listContentDocumentAsinRelations: (
          contentReferenceKey: string,
          marketplaceId: string,
          includedDataSet?: Set<"METADATA">,
          asinSet?: Set<string>,
          pageToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • postContentDocumentApprovalSubmission: (
          contentReferenceKey: string,
          marketplaceId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Submits an A+ Content document for review, approval, and publishing. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • postContentDocumentAsinRelations: (
          contentReferenceKey: string,
          marketplaceId: string,
          postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • postContentDocumentSuspendSubmission: (
          contentReferenceKey: string,
          marketplaceId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • searchContentDocuments: (
          marketplaceId: string,
          pageToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • searchContentPublishRecords: (
          marketplaceId: string,
          asin: string,
          pageToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Searches for A+ Content publishing records, if available. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • updateContentDocument: (
          contentReferenceKey: string,
          marketplaceId: string,
          postContentDocumentRequest: PostContentDocumentRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Updates an existing A+ Content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

    • validateContentDocumentAsinRelations: (
          marketplaceId: string,
          postContentDocumentRequest: PostContentDocumentRequest,
          asinSet?: Set<string>,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Checks if the A+ Content document is valid for use on a set of ASINs. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

      Throws

Settings

Member Visibility