@cmarket/partner-sdk 37.3.1 → 38.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -5
- package/api/embed-api.ts +2 -2
- package/api/oauth-api.ts +2 -2
- package/api/partner-api-api.ts +688 -6
- package/api/products-api.ts +21 -13
- package/api/well-known-api.ts +2 -2
- package/api.ts +2 -2
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api/embed-api.d.ts +2 -2
- package/dist/api/embed-api.js +2 -2
- package/dist/api/oauth-api.d.ts +2 -2
- package/dist/api/oauth-api.js +2 -2
- package/dist/api/partner-api-api.d.ts +310 -6
- package/dist/api/partner-api-api.js +644 -6
- package/dist/api/products-api.d.ts +14 -10
- package/dist/api/products-api.js +20 -13
- package/dist/api/well-known-api.d.ts +2 -2
- package/dist/api/well-known-api.js +2 -2
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api/embed-api.d.ts +2 -2
- package/dist/esm/api/embed-api.js +2 -2
- package/dist/esm/api/oauth-api.d.ts +2 -2
- package/dist/esm/api/oauth-api.js +2 -2
- package/dist/esm/api/partner-api-api.d.ts +310 -6
- package/dist/esm/api/partner-api-api.js +644 -6
- package/dist/esm/api/products-api.d.ts +14 -10
- package/dist/esm/api/products-api.js +20 -13
- package/dist/esm/api/well-known-api.d.ts +2 -2
- package/dist/esm/api/well-known-api.js +2 -2
- package/dist/esm/api.d.ts +2 -2
- package/dist/esm/api.js +2 -2
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/esm/models/acceptance-result-response-dto.d.ts +2 -2
- package/dist/esm/models/acceptance-result-response-dto.js +2 -2
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +2 -8
- package/dist/esm/models/acknowledge-product-receipt200-response.js +2 -2
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +2 -2
- package/dist/esm/models/acknowledge-products-request-dto.js +2 -2
- package/dist/esm/models/api-catalog-dto.d.ts +2 -2
- package/dist/esm/models/api-catalog-dto.js +2 -2
- package/dist/esm/models/api-catalog-entry-dto.d.ts +2 -2
- package/dist/esm/models/api-catalog-entry-dto.js +2 -2
- package/dist/esm/models/api-catalog-link-dto.d.ts +2 -2
- package/dist/esm/models/api-catalog-link-dto.js +2 -2
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +2 -2
- package/dist/esm/models/authorization-server-metadata-dto.js +2 -2
- package/dist/esm/models/award-method-public.d.ts +2 -2
- package/dist/esm/models/award-method-public.js +2 -2
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +2 -2
- package/dist/esm/models/award-registered-v2-response-dto.js +2 -2
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +2 -2
- package/dist/esm/models/award-reverted-v2-response-dto.js +2 -2
- package/dist/esm/models/bid-acceptance-dto.d.ts +2 -2
- package/dist/esm/models/bid-acceptance-dto.js +2 -2
- package/dist/esm/models/bid-attachment-input-dto.d.ts +2 -2
- package/dist/esm/models/bid-attachment-input-dto.js +2 -2
- package/dist/esm/models/bid-bond-dto.d.ts +2 -2
- package/dist/esm/models/bid-bond-dto.js +2 -2
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-cancelled-response-dto.js +2 -2
- package/dist/esm/models/bid-contact-dto.d.ts +2 -2
- package/dist/esm/models/bid-contact-dto.js +2 -2
- package/dist/esm/models/bid-contacts-dto.d.ts +2 -2
- package/dist/esm/models/bid-contacts-dto.js +2 -2
- package/dist/esm/models/bid-contract-document-dto.d.ts +2 -2
- package/dist/esm/models/bid-contract-document-dto.js +2 -2
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +2 -2
- package/dist/esm/models/bid-delivery-terms-dto.js +2 -2
- package/dist/esm/models/bid-detail-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-detail-response-dto.js +2 -2
- package/dist/esm/models/bid-document-dto.d.ts +2 -2
- package/dist/esm/models/bid-document-dto.js +2 -2
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-failed-v2-response-dto.js +2 -2
- package/dist/esm/models/bid-item-dto.d.ts +2 -2
- package/dist/esm/models/bid-item-dto.js +2 -2
- package/dist/esm/models/bid-lifecycle-dto.d.ts +2 -2
- package/dist/esm/models/bid-lifecycle-dto.js +2 -2
- package/dist/esm/models/bid-manager-dto.d.ts +2 -2
- package/dist/esm/models/bid-manager-dto.js +2 -2
- package/dist/esm/models/bid-payment-terms-dto.d.ts +2 -2
- package/dist/esm/models/bid-payment-terms-dto.js +2 -2
- package/dist/esm/models/bid-product-dto.d.ts +2 -2
- package/dist/esm/models/bid-product-dto.js +2 -2
- package/dist/esm/models/bid-public-status.d.ts +2 -2
- package/dist/esm/models/bid-public-status.js +2 -2
- package/dist/esm/models/bid-registered-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-registered-response-dto.js +2 -2
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +2 -2
- package/dist/esm/models/bid-result-participant-attachment-dto.js +2 -2
- package/dist/esm/models/bid-result-participant-dto.d.ts +2 -2
- package/dist/esm/models/bid-result-participant-dto.js +2 -2
- package/dist/esm/models/bid-results-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-results-response-dto.js +2 -2
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-line-item-dto.js +2 -2
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-participant-dto.js +2 -2
- package/dist/esm/models/bid-settlement-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-response-dto.js +2 -2
- package/dist/esm/models/bid-statement-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-statement-response-dto.js +2 -2
- package/dist/esm/models/bid-summary-dto.d.ts +2 -2
- package/dist/esm/models/bid-summary-dto.js +2 -2
- package/dist/esm/models/bid-type-public.d.ts +2 -2
- package/dist/esm/models/bid-type-public.js +2 -2
- package/dist/esm/models/bid-updated-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-updated-response-dto.js +2 -2
- package/dist/esm/models/cancel-bid-request-dto.d.ts +2 -2
- package/dist/esm/models/cancel-bid-request-dto.js +2 -2
- package/dist/esm/models/cancel-bid200-response.d.ts +2 -8
- package/dist/esm/models/cancel-bid200-response.js +2 -2
- package/dist/esm/models/card-payment-request-response-dto.d.ts +2 -2
- package/dist/esm/models/card-payment-request-response-dto.js +2 -2
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +2 -2
- package/dist/esm/models/complete-acceptance-request-dto.js +2 -2
- package/dist/esm/models/complete-acceptance200-response.d.ts +2 -8
- package/dist/esm/models/complete-acceptance200-response.js +2 -2
- package/dist/esm/models/complete-invoice200-response.d.ts +2 -8
- package/dist/esm/models/complete-invoice200-response.js +2 -2
- package/dist/esm/models/complete-upload-request-dto.d.ts +2 -2
- package/dist/esm/models/complete-upload-request-dto.js +2 -2
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +2 -2
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +2 -2
- package/dist/esm/models/create-bid-request-dto.d.ts +2 -2
- package/dist/esm/models/create-bid-request-dto.js +2 -2
- package/dist/esm/models/create-card-payment-dto.d.ts +2 -2
- package/dist/esm/models/create-card-payment-dto.js +2 -2
- package/dist/esm/models/create-card-payment-request-dto.d.ts +2 -2
- package/dist/esm/models/create-card-payment-request-dto.js +2 -2
- package/dist/esm/models/create-card-payment200-response.d.ts +2 -8
- package/dist/esm/models/create-card-payment200-response.js +2 -2
- package/dist/esm/models/create-embed-launch201-response.d.ts +2 -8
- package/dist/esm/models/create-embed-launch201-response.js +2 -2
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +2 -2
- package/dist/esm/models/create-external-contract-documents-request-dto.js +2 -2
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +2 -2
- package/dist/esm/models/create-external-contract-documents-response-dto.js +2 -2
- package/dist/esm/models/create-file-upload-url201-response.d.ts +2 -8
- package/dist/esm/models/create-file-upload-url201-response.js +2 -2
- package/dist/esm/models/create-upload-url-request-dto.d.ts +2 -2
- package/dist/esm/models/create-upload-url-request-dto.js +2 -2
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +22 -0
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +14 -0
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +15 -0
- package/dist/esm/models/create-webhook-endpoint201-response.js +14 -0
- package/dist/esm/models/delivery-date-type-public.d.ts +2 -2
- package/dist/esm/models/delivery-date-type-public.js +2 -2
- package/dist/esm/models/delivery-method-public.d.ts +2 -2
- package/dist/esm/models/delivery-method-public.js +2 -2
- package/dist/esm/models/embed-launch-request-dto.d.ts +2 -2
- package/dist/esm/models/embed-launch-request-dto.js +2 -2
- package/dist/esm/models/embed-launch-response-dto.d.ts +2 -2
- package/dist/esm/models/embed-launch-response-dto.js +2 -2
- package/dist/esm/models/excellent-procurement-public.d.ts +2 -2
- package/dist/esm/models/excellent-procurement-public.js +2 -2
- package/dist/esm/models/external-contract-document-item-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-document-item-dto.js +2 -2
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-documents-response-dto.js +2 -2
- package/dist/esm/models/external-contract-item-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-item-dto.js +2 -2
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-snapshot-dto.js +2 -2
- package/dist/esm/models/external-document-inputs-dto.d.ts +2 -2
- package/dist/esm/models/external-document-inputs-dto.js +2 -2
- package/dist/esm/models/file-meta-response-dto.d.ts +2 -2
- package/dist/esm/models/file-meta-response-dto.js +2 -2
- package/dist/esm/models/file-uploaded-response-dto.d.ts +2 -2
- package/dist/esm/models/file-uploaded-response-dto.js +2 -2
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +2 -2
- package/dist/esm/models/generated-external-contract-document-dto.js +2 -2
- package/dist/esm/models/get-bid-settlement200-response.d.ts +2 -8
- package/dist/esm/models/get-bid-settlement200-response.js +2 -2
- package/dist/esm/models/get-bid-statement200-response.d.ts +2 -8
- package/dist/esm/models/get-bid-statement200-response.js +2 -2
- package/dist/esm/models/get-bid200-response.d.ts +2 -8
- package/dist/esm/models/get-bid200-response.js +2 -2
- package/dist/esm/models/get-file-meta200-response.d.ts +2 -8
- package/dist/esm/models/get-file-meta200-response.js +2 -2
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +2 -8
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +2 -2
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +15 -0
- package/dist/esm/models/get-webhook-endpoint200-response.js +14 -0
- package/dist/esm/models/green-product-public.d.ts +2 -2
- package/dist/esm/models/green-product-public.js +2 -2
- package/dist/esm/models/health-controller-check200-response.d.ts +2 -8
- package/dist/esm/models/health-controller-check200-response.js +2 -2
- package/dist/esm/models/health-response-dto.d.ts +2 -2
- package/dist/esm/models/health-response-dto.js +2 -2
- package/dist/esm/models/hierarchical-region-dto.d.ts +2 -2
- package/dist/esm/models/hierarchical-region-dto.js +2 -2
- package/dist/esm/models/index.d.ts +16 -1
- package/dist/esm/models/index.js +16 -1
- package/dist/esm/models/introspect-request-dto.d.ts +2 -2
- package/dist/esm/models/introspect-request-dto.js +2 -2
- package/dist/esm/models/introspection-response-dto.d.ts +2 -2
- package/dist/esm/models/introspection-response-dto.js +2 -2
- package/dist/esm/models/invalid-param-dto.d.ts +2 -2
- package/dist/esm/models/invalid-param-dto.js +2 -2
- package/dist/esm/models/invoice-completed-response-dto.d.ts +2 -2
- package/dist/esm/models/invoice-completed-response-dto.js +2 -2
- package/dist/esm/models/invoice-split-response-dto.d.ts +2 -2
- package/dist/esm/models/invoice-split-response-dto.js +2 -2
- package/dist/esm/models/legal-mandatory-public.d.ts +2 -2
- package/dist/esm/models/legal-mandatory-public.js +2 -2
- package/dist/esm/models/list-bid-results200-response.d.ts +4 -8
- package/dist/esm/models/list-bid-results200-response.js +2 -2
- package/dist/esm/models/list-bids200-response-meta.d.ts +24 -0
- package/dist/esm/models/list-bids200-response-meta.js +14 -0
- package/dist/esm/models/list-bids200-response.d.ts +6 -10
- package/dist/esm/models/list-bids200-response.js +2 -2
- package/dist/esm/models/list-products200-response.d.ts +4 -8
- package/dist/esm/models/list-products200-response.js +2 -2
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +22 -0
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +14 -0
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +15 -0
- package/dist/esm/models/list-webhook-deliveries200-response.js +14 -0
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +17 -0
- package/dist/esm/models/list-webhook-endpoints200-response.js +14 -0
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +2 -2
- package/dist/esm/models/mark-bid-failed-request-dto.js +2 -2
- package/dist/esm/models/mark-bid-failed201-response.d.ts +2 -8
- package/dist/esm/models/mark-bid-failed201-response.js +2 -2
- package/dist/esm/models/negotiation-score-dto.d.ts +2 -2
- package/dist/esm/models/negotiation-score-dto.js +2 -2
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +2 -2
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +2 -2
- package/dist/esm/models/oauth-error-response-dto.d.ts +2 -2
- package/dist/esm/models/oauth-error-response-dto.js +2 -2
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +18 -0
- package/dist/esm/models/partner-webhook-delivery-status.js +19 -0
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +19 -0
- package/dist/esm/models/partner-webhook-endpoint-status.js +20 -0
- package/dist/esm/models/partner-webhook-event-type.d.ts +22 -0
- package/dist/esm/models/partner-webhook-event-type.js +23 -0
- package/dist/esm/models/payment-method-public.d.ts +2 -2
- package/dist/esm/models/payment-method-public.js +2 -2
- package/dist/esm/models/preconditions-dto.d.ts +2 -2
- package/dist/esm/models/preconditions-dto.js +2 -2
- package/dist/esm/models/problem-details-dto.d.ts +2 -2
- package/dist/esm/models/problem-details-dto.js +2 -2
- package/dist/esm/models/product-receipt-response-dto.d.ts +2 -2
- package/dist/esm/models/product-receipt-response-dto.js +2 -2
- package/dist/esm/models/product-response-dto.d.ts +2 -2
- package/dist/esm/models/product-response-dto.js +2 -2
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +2 -2
- package/dist/esm/models/protected-resource-metadata-dto.js +2 -2
- package/dist/esm/models/register-award-request-dto.d.ts +2 -2
- package/dist/esm/models/register-award-request-dto.js +2 -2
- package/dist/esm/models/register-award201-response.d.ts +2 -8
- package/dist/esm/models/register-award201-response.js +2 -2
- package/dist/esm/models/register-bid201-response.d.ts +2 -8
- package/dist/esm/models/register-bid201-response.js +2 -2
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +2 -2
- package/dist/esm/models/register-semo-contract-request-dto.js +2 -2
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +2 -2
- package/dist/esm/models/request-invoice-split-request-dto.js +2 -2
- package/dist/esm/models/request-invoice-split200-response.d.ts +2 -8
- package/dist/esm/models/request-invoice-split200-response.js +2 -2
- package/dist/esm/models/retiree-roster-input-dto.d.ts +2 -2
- package/dist/esm/models/retiree-roster-input-dto.js +2 -2
- package/dist/esm/models/retiree-roster-row-dto.d.ts +2 -2
- package/dist/esm/models/retiree-roster-row-dto.js +2 -2
- package/dist/esm/models/revert-award-request-dto.d.ts +2 -2
- package/dist/esm/models/revert-award-request-dto.js +2 -2
- package/dist/esm/models/revert-award200-response.d.ts +2 -8
- package/dist/esm/models/revert-award200-response.js +2 -2
- package/dist/esm/models/revoke-request-dto.d.ts +2 -2
- package/dist/esm/models/revoke-request-dto.js +2 -2
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +2 -2
- package/dist/esm/models/semo-contract-registered-response-dto.js +2 -2
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +2 -2
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +2 -2
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +15 -0
- package/dist/esm/models/send-webhook-test-event200-response.js +14 -0
- package/dist/esm/models/statement-document-dto.d.ts +2 -2
- package/dist/esm/models/statement-document-dto.js +2 -2
- package/dist/esm/models/statement-product-dto.d.ts +2 -2
- package/dist/esm/models/statement-product-dto.js +2 -2
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +2 -2
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +2 -2
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +2 -8
- package/dist/esm/models/submit-negotiation-scores201-response.js +2 -2
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +2 -2
- package/dist/esm/models/supplier-card-payable-response-dto.js +2 -2
- package/dist/esm/models/supplier-tax-type.d.ts +2 -2
- package/dist/esm/models/supplier-tax-type.js +2 -2
- package/dist/esm/models/token-request-dto.d.ts +2 -2
- package/dist/esm/models/token-request-dto.js +2 -2
- package/dist/esm/models/token-response-dto.d.ts +2 -2
- package/dist/esm/models/token-response-dto.js +2 -2
- package/dist/esm/models/update-bid-request-dto.d.ts +2 -2
- package/dist/esm/models/update-bid-request-dto.js +2 -2
- package/dist/esm/models/update-bid200-response.d.ts +2 -8
- package/dist/esm/models/update-bid200-response.js +2 -2
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +27 -0
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +14 -0
- package/dist/esm/models/upload-file-request-dto.d.ts +2 -2
- package/dist/esm/models/upload-file-request-dto.js +2 -2
- package/dist/esm/models/upload-file201-response.d.ts +2 -8
- package/dist/esm/models/upload-file201-response.js +2 -2
- package/dist/esm/models/upload-url-created-response-dto.d.ts +2 -2
- package/dist/esm/models/upload-url-created-response-dto.js +2 -2
- package/dist/esm/models/webhook-delivery-dto.d.ts +73 -0
- package/dist/esm/models/webhook-delivery-dto.js +21 -0
- package/dist/esm/models/webhook-endpoint-dto.d.ts +55 -0
- package/dist/esm/models/webhook-endpoint-dto.js +14 -0
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +59 -0
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +14 -0
- package/dist/esm/models/webhook-test-result-dto.d.ts +25 -0
- package/dist/esm/models/webhook-test-result-dto.js +14 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/models/acceptance-result-response-dto.d.ts +2 -2
- package/dist/models/acceptance-result-response-dto.js +2 -2
- package/dist/models/acknowledge-product-receipt200-response.d.ts +2 -8
- package/dist/models/acknowledge-product-receipt200-response.js +2 -2
- package/dist/models/acknowledge-products-request-dto.d.ts +2 -2
- package/dist/models/acknowledge-products-request-dto.js +2 -2
- package/dist/models/api-catalog-dto.d.ts +2 -2
- package/dist/models/api-catalog-dto.js +2 -2
- package/dist/models/api-catalog-entry-dto.d.ts +2 -2
- package/dist/models/api-catalog-entry-dto.js +2 -2
- package/dist/models/api-catalog-link-dto.d.ts +2 -2
- package/dist/models/api-catalog-link-dto.js +2 -2
- package/dist/models/authorization-server-metadata-dto.d.ts +2 -2
- package/dist/models/authorization-server-metadata-dto.js +2 -2
- package/dist/models/award-method-public.d.ts +2 -2
- package/dist/models/award-method-public.js +2 -2
- package/dist/models/award-registered-v2-response-dto.d.ts +2 -2
- package/dist/models/award-registered-v2-response-dto.js +2 -2
- package/dist/models/award-reverted-v2-response-dto.d.ts +2 -2
- package/dist/models/award-reverted-v2-response-dto.js +2 -2
- package/dist/models/bid-acceptance-dto.d.ts +2 -2
- package/dist/models/bid-acceptance-dto.js +2 -2
- package/dist/models/bid-attachment-input-dto.d.ts +2 -2
- package/dist/models/bid-attachment-input-dto.js +2 -2
- package/dist/models/bid-bond-dto.d.ts +2 -2
- package/dist/models/bid-bond-dto.js +2 -2
- package/dist/models/bid-cancelled-response-dto.d.ts +2 -2
- package/dist/models/bid-cancelled-response-dto.js +2 -2
- package/dist/models/bid-contact-dto.d.ts +2 -2
- package/dist/models/bid-contact-dto.js +2 -2
- package/dist/models/bid-contacts-dto.d.ts +2 -2
- package/dist/models/bid-contacts-dto.js +2 -2
- package/dist/models/bid-contract-document-dto.d.ts +2 -2
- package/dist/models/bid-contract-document-dto.js +2 -2
- package/dist/models/bid-delivery-terms-dto.d.ts +2 -2
- package/dist/models/bid-delivery-terms-dto.js +2 -2
- package/dist/models/bid-detail-response-dto.d.ts +2 -2
- package/dist/models/bid-detail-response-dto.js +2 -2
- package/dist/models/bid-document-dto.d.ts +2 -2
- package/dist/models/bid-document-dto.js +2 -2
- package/dist/models/bid-failed-v2-response-dto.d.ts +2 -2
- package/dist/models/bid-failed-v2-response-dto.js +2 -2
- package/dist/models/bid-item-dto.d.ts +2 -2
- package/dist/models/bid-item-dto.js +2 -2
- package/dist/models/bid-lifecycle-dto.d.ts +2 -2
- package/dist/models/bid-lifecycle-dto.js +2 -2
- package/dist/models/bid-manager-dto.d.ts +2 -2
- package/dist/models/bid-manager-dto.js +2 -2
- package/dist/models/bid-payment-terms-dto.d.ts +2 -2
- package/dist/models/bid-payment-terms-dto.js +2 -2
- package/dist/models/bid-product-dto.d.ts +2 -2
- package/dist/models/bid-product-dto.js +2 -2
- package/dist/models/bid-public-status.d.ts +2 -2
- package/dist/models/bid-public-status.js +2 -2
- package/dist/models/bid-registered-response-dto.d.ts +2 -2
- package/dist/models/bid-registered-response-dto.js +2 -2
- package/dist/models/bid-result-participant-attachment-dto.d.ts +2 -2
- package/dist/models/bid-result-participant-attachment-dto.js +2 -2
- package/dist/models/bid-result-participant-dto.d.ts +2 -2
- package/dist/models/bid-result-participant-dto.js +2 -2
- package/dist/models/bid-results-response-dto.d.ts +2 -2
- package/dist/models/bid-results-response-dto.js +2 -2
- package/dist/models/bid-settlement-line-item-dto.d.ts +2 -2
- package/dist/models/bid-settlement-line-item-dto.js +2 -2
- package/dist/models/bid-settlement-participant-dto.d.ts +2 -2
- package/dist/models/bid-settlement-participant-dto.js +2 -2
- package/dist/models/bid-settlement-response-dto.d.ts +2 -2
- package/dist/models/bid-settlement-response-dto.js +2 -2
- package/dist/models/bid-statement-response-dto.d.ts +2 -2
- package/dist/models/bid-statement-response-dto.js +2 -2
- package/dist/models/bid-summary-dto.d.ts +2 -2
- package/dist/models/bid-summary-dto.js +2 -2
- package/dist/models/bid-type-public.d.ts +2 -2
- package/dist/models/bid-type-public.js +2 -2
- package/dist/models/bid-updated-response-dto.d.ts +2 -2
- package/dist/models/bid-updated-response-dto.js +2 -2
- package/dist/models/cancel-bid-request-dto.d.ts +2 -2
- package/dist/models/cancel-bid-request-dto.js +2 -2
- package/dist/models/cancel-bid200-response.d.ts +2 -8
- package/dist/models/cancel-bid200-response.js +2 -2
- package/dist/models/card-payment-request-response-dto.d.ts +2 -2
- package/dist/models/card-payment-request-response-dto.js +2 -2
- package/dist/models/complete-acceptance-request-dto.d.ts +2 -2
- package/dist/models/complete-acceptance-request-dto.js +2 -2
- package/dist/models/complete-acceptance200-response.d.ts +2 -8
- package/dist/models/complete-acceptance200-response.js +2 -2
- package/dist/models/complete-invoice200-response.d.ts +2 -8
- package/dist/models/complete-invoice200-response.js +2 -2
- package/dist/models/complete-upload-request-dto.d.ts +2 -2
- package/dist/models/complete-upload-request-dto.js +2 -2
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +2 -2
- package/dist/models/contract-restriction-confirm-input-dto.js +2 -2
- package/dist/models/create-bid-request-dto.d.ts +2 -2
- package/dist/models/create-bid-request-dto.js +2 -2
- package/dist/models/create-card-payment-dto.d.ts +2 -2
- package/dist/models/create-card-payment-dto.js +2 -2
- package/dist/models/create-card-payment-request-dto.d.ts +2 -2
- package/dist/models/create-card-payment-request-dto.js +2 -2
- package/dist/models/create-card-payment200-response.d.ts +2 -8
- package/dist/models/create-card-payment200-response.js +2 -2
- package/dist/models/create-embed-launch201-response.d.ts +2 -8
- package/dist/models/create-embed-launch201-response.js +2 -2
- package/dist/models/create-external-contract-documents-request-dto.d.ts +2 -2
- package/dist/models/create-external-contract-documents-request-dto.js +2 -2
- package/dist/models/create-external-contract-documents-response-dto.d.ts +2 -2
- package/dist/models/create-external-contract-documents-response-dto.js +2 -2
- package/dist/models/create-file-upload-url201-response.d.ts +2 -8
- package/dist/models/create-file-upload-url201-response.js +2 -2
- package/dist/models/create-upload-url-request-dto.d.ts +2 -2
- package/dist/models/create-upload-url-request-dto.js +2 -2
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +22 -0
- package/dist/models/create-webhook-endpoint-request-dto.js +15 -0
- package/dist/models/create-webhook-endpoint201-response.d.ts +15 -0
- package/dist/models/create-webhook-endpoint201-response.js +15 -0
- package/dist/models/delivery-date-type-public.d.ts +2 -2
- package/dist/models/delivery-date-type-public.js +2 -2
- package/dist/models/delivery-method-public.d.ts +2 -2
- package/dist/models/delivery-method-public.js +2 -2
- package/dist/models/embed-launch-request-dto.d.ts +2 -2
- package/dist/models/embed-launch-request-dto.js +2 -2
- package/dist/models/embed-launch-response-dto.d.ts +2 -2
- package/dist/models/embed-launch-response-dto.js +2 -2
- package/dist/models/excellent-procurement-public.d.ts +2 -2
- package/dist/models/excellent-procurement-public.js +2 -2
- package/dist/models/external-contract-document-item-dto.d.ts +2 -2
- package/dist/models/external-contract-document-item-dto.js +2 -2
- package/dist/models/external-contract-documents-response-dto.d.ts +2 -2
- package/dist/models/external-contract-documents-response-dto.js +2 -2
- package/dist/models/external-contract-item-dto.d.ts +2 -2
- package/dist/models/external-contract-item-dto.js +2 -2
- package/dist/models/external-contract-snapshot-dto.d.ts +2 -2
- package/dist/models/external-contract-snapshot-dto.js +2 -2
- package/dist/models/external-document-inputs-dto.d.ts +2 -2
- package/dist/models/external-document-inputs-dto.js +2 -2
- package/dist/models/file-meta-response-dto.d.ts +2 -2
- package/dist/models/file-meta-response-dto.js +2 -2
- package/dist/models/file-uploaded-response-dto.d.ts +2 -2
- package/dist/models/file-uploaded-response-dto.js +2 -2
- package/dist/models/generated-external-contract-document-dto.d.ts +2 -2
- package/dist/models/generated-external-contract-document-dto.js +2 -2
- package/dist/models/get-bid-settlement200-response.d.ts +2 -8
- package/dist/models/get-bid-settlement200-response.js +2 -2
- package/dist/models/get-bid-statement200-response.d.ts +2 -8
- package/dist/models/get-bid-statement200-response.js +2 -2
- package/dist/models/get-bid200-response.d.ts +2 -8
- package/dist/models/get-bid200-response.js +2 -2
- package/dist/models/get-file-meta200-response.d.ts +2 -8
- package/dist/models/get-file-meta200-response.js +2 -2
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +2 -8
- package/dist/models/get-supplier-card-payable-v2200-response.js +2 -2
- package/dist/models/get-webhook-endpoint200-response.d.ts +15 -0
- package/dist/models/get-webhook-endpoint200-response.js +15 -0
- package/dist/models/green-product-public.d.ts +2 -2
- package/dist/models/green-product-public.js +2 -2
- package/dist/models/health-controller-check200-response.d.ts +2 -8
- package/dist/models/health-controller-check200-response.js +2 -2
- package/dist/models/health-response-dto.d.ts +2 -2
- package/dist/models/health-response-dto.js +2 -2
- package/dist/models/hierarchical-region-dto.d.ts +2 -2
- package/dist/models/hierarchical-region-dto.js +2 -2
- package/dist/models/index.d.ts +16 -1
- package/dist/models/index.js +16 -1
- package/dist/models/introspect-request-dto.d.ts +2 -2
- package/dist/models/introspect-request-dto.js +2 -2
- package/dist/models/introspection-response-dto.d.ts +2 -2
- package/dist/models/introspection-response-dto.js +2 -2
- package/dist/models/invalid-param-dto.d.ts +2 -2
- package/dist/models/invalid-param-dto.js +2 -2
- package/dist/models/invoice-completed-response-dto.d.ts +2 -2
- package/dist/models/invoice-completed-response-dto.js +2 -2
- package/dist/models/invoice-split-response-dto.d.ts +2 -2
- package/dist/models/invoice-split-response-dto.js +2 -2
- package/dist/models/legal-mandatory-public.d.ts +2 -2
- package/dist/models/legal-mandatory-public.js +2 -2
- package/dist/models/list-bid-results200-response.d.ts +4 -8
- package/dist/models/list-bid-results200-response.js +2 -2
- package/dist/models/list-bids200-response-meta.d.ts +24 -0
- package/dist/models/list-bids200-response-meta.js +15 -0
- package/dist/models/list-bids200-response.d.ts +6 -10
- package/dist/models/list-bids200-response.js +2 -2
- package/dist/models/list-products200-response.d.ts +4 -8
- package/dist/models/list-products200-response.js +2 -2
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +22 -0
- package/dist/models/list-webhook-deliveries-response-dto.js +15 -0
- package/dist/models/list-webhook-deliveries200-response.d.ts +15 -0
- package/dist/models/list-webhook-deliveries200-response.js +15 -0
- package/dist/models/list-webhook-endpoints200-response.d.ts +17 -0
- package/dist/models/list-webhook-endpoints200-response.js +15 -0
- package/dist/models/mark-bid-failed-request-dto.d.ts +2 -2
- package/dist/models/mark-bid-failed-request-dto.js +2 -2
- package/dist/models/mark-bid-failed201-response.d.ts +2 -8
- package/dist/models/mark-bid-failed201-response.js +2 -2
- package/dist/models/negotiation-score-dto.d.ts +2 -2
- package/dist/models/negotiation-score-dto.js +2 -2
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +2 -2
- package/dist/models/negotiation-scored-v2-response-dto.js +2 -2
- package/dist/models/oauth-error-response-dto.d.ts +2 -2
- package/dist/models/oauth-error-response-dto.js +2 -2
- package/dist/models/partner-webhook-delivery-status.d.ts +18 -0
- package/dist/models/partner-webhook-delivery-status.js +22 -0
- package/dist/models/partner-webhook-endpoint-status.d.ts +19 -0
- package/dist/models/partner-webhook-endpoint-status.js +23 -0
- package/dist/models/partner-webhook-event-type.d.ts +22 -0
- package/dist/models/partner-webhook-event-type.js +26 -0
- package/dist/models/payment-method-public.d.ts +2 -2
- package/dist/models/payment-method-public.js +2 -2
- package/dist/models/preconditions-dto.d.ts +2 -2
- package/dist/models/preconditions-dto.js +2 -2
- package/dist/models/problem-details-dto.d.ts +2 -2
- package/dist/models/problem-details-dto.js +2 -2
- package/dist/models/product-receipt-response-dto.d.ts +2 -2
- package/dist/models/product-receipt-response-dto.js +2 -2
- package/dist/models/product-response-dto.d.ts +2 -2
- package/dist/models/product-response-dto.js +2 -2
- package/dist/models/protected-resource-metadata-dto.d.ts +2 -2
- package/dist/models/protected-resource-metadata-dto.js +2 -2
- package/dist/models/register-award-request-dto.d.ts +2 -2
- package/dist/models/register-award-request-dto.js +2 -2
- package/dist/models/register-award201-response.d.ts +2 -8
- package/dist/models/register-award201-response.js +2 -2
- package/dist/models/register-bid201-response.d.ts +2 -8
- package/dist/models/register-bid201-response.js +2 -2
- package/dist/models/register-semo-contract-request-dto.d.ts +2 -2
- package/dist/models/register-semo-contract-request-dto.js +2 -2
- package/dist/models/request-invoice-split-request-dto.d.ts +2 -2
- package/dist/models/request-invoice-split-request-dto.js +2 -2
- package/dist/models/request-invoice-split200-response.d.ts +2 -8
- package/dist/models/request-invoice-split200-response.js +2 -2
- package/dist/models/retiree-roster-input-dto.d.ts +2 -2
- package/dist/models/retiree-roster-input-dto.js +2 -2
- package/dist/models/retiree-roster-row-dto.d.ts +2 -2
- package/dist/models/retiree-roster-row-dto.js +2 -2
- package/dist/models/revert-award-request-dto.d.ts +2 -2
- package/dist/models/revert-award-request-dto.js +2 -2
- package/dist/models/revert-award200-response.d.ts +2 -8
- package/dist/models/revert-award200-response.js +2 -2
- package/dist/models/revoke-request-dto.d.ts +2 -2
- package/dist/models/revoke-request-dto.js +2 -2
- package/dist/models/semo-contract-registered-response-dto.d.ts +2 -2
- package/dist/models/semo-contract-registered-response-dto.js +2 -2
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +2 -2
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +2 -2
- package/dist/models/send-webhook-test-event200-response.d.ts +15 -0
- package/dist/models/send-webhook-test-event200-response.js +15 -0
- package/dist/models/statement-document-dto.d.ts +2 -2
- package/dist/models/statement-document-dto.js +2 -2
- package/dist/models/statement-product-dto.d.ts +2 -2
- package/dist/models/statement-product-dto.js +2 -2
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +2 -2
- package/dist/models/submit-negotiation-scores-request-dto.js +2 -2
- package/dist/models/submit-negotiation-scores201-response.d.ts +2 -8
- package/dist/models/submit-negotiation-scores201-response.js +2 -2
- package/dist/models/supplier-card-payable-response-dto.d.ts +2 -2
- package/dist/models/supplier-card-payable-response-dto.js +2 -2
- package/dist/models/supplier-tax-type.d.ts +2 -2
- package/dist/models/supplier-tax-type.js +2 -2
- package/dist/models/token-request-dto.d.ts +2 -2
- package/dist/models/token-request-dto.js +2 -2
- package/dist/models/token-response-dto.d.ts +2 -2
- package/dist/models/token-response-dto.js +2 -2
- package/dist/models/update-bid-request-dto.d.ts +2 -2
- package/dist/models/update-bid-request-dto.js +2 -2
- package/dist/models/update-bid200-response.d.ts +2 -8
- package/dist/models/update-bid200-response.js +2 -2
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +27 -0
- package/dist/models/update-webhook-endpoint-request-dto.js +15 -0
- package/dist/models/upload-file-request-dto.d.ts +2 -2
- package/dist/models/upload-file-request-dto.js +2 -2
- package/dist/models/upload-file201-response.d.ts +2 -8
- package/dist/models/upload-file201-response.js +2 -2
- package/dist/models/upload-url-created-response-dto.d.ts +2 -2
- package/dist/models/upload-url-created-response-dto.js +2 -2
- package/dist/models/webhook-delivery-dto.d.ts +73 -0
- package/dist/models/webhook-delivery-dto.js +24 -0
- package/dist/models/webhook-endpoint-dto.d.ts +55 -0
- package/dist/models/webhook-endpoint-dto.js +15 -0
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +59 -0
- package/dist/models/webhook-endpoint-with-secret-dto.js +15 -0
- package/dist/models/webhook-test-result-dto.d.ts +25 -0
- package/dist/models/webhook-test-result-dto.js +15 -0
- package/docs/AcknowledgeProductReceipt200Response.md +0 -2
- package/docs/CancelBid200Response.md +0 -2
- package/docs/CompleteAcceptance200Response.md +0 -2
- package/docs/CompleteInvoice200Response.md +0 -2
- package/docs/CreateCardPayment200Response.md +0 -2
- package/docs/CreateEmbedLaunch201Response.md +0 -2
- package/docs/CreateFileUploadUrl201Response.md +0 -2
- package/docs/CreateWebhookEndpoint201Response.md +20 -0
- package/docs/CreateWebhookEndpointRequestDto.md +22 -0
- package/docs/GetBid200Response.md +0 -2
- package/docs/GetBidSettlement200Response.md +0 -2
- package/docs/GetBidStatement200Response.md +0 -2
- package/docs/GetFileMeta200Response.md +0 -2
- package/docs/GetSupplierCardPayableV2200Response.md +0 -2
- package/docs/GetWebhookEndpoint200Response.md +20 -0
- package/docs/HealthControllerCheck200Response.md +0 -2
- package/docs/ListBidResults200Response.md +1 -1
- package/docs/ListBids200Response.md +2 -2
- package/docs/ListBids200ResponseMeta.md +23 -0
- package/docs/ListProducts200Response.md +1 -1
- package/docs/ListWebhookDeliveries200Response.md +20 -0
- package/docs/{ListBidsResponseDto.md → ListWebhookDeliveriesResponseDto.md} +4 -4
- package/docs/ListWebhookEndpoints200Response.md +22 -0
- package/docs/MarkBidFailed201Response.md +0 -2
- package/docs/PartnerApiApi.md +520 -3
- package/docs/PartnerWebhookDeliveryStatus.md +14 -0
- package/docs/PartnerWebhookEndpointStatus.md +11 -0
- package/docs/PartnerWebhookEventType.md +17 -0
- package/docs/ProductsApi.md +10 -3
- package/docs/RegisterAward201Response.md +0 -2
- package/docs/RegisterBid201Response.md +0 -2
- package/docs/RequestInvoiceSplit200Response.md +0 -2
- package/docs/RevertAward200Response.md +0 -2
- package/docs/SendWebhookTestEvent200Response.md +20 -0
- package/docs/SubmitNegotiationScores201Response.md +0 -2
- package/docs/UpdateBid200Response.md +0 -2
- package/docs/UpdateWebhookEndpointRequestDto.md +24 -0
- package/docs/UploadFile201Response.md +0 -2
- package/docs/WebhookDeliveryDto.md +42 -0
- package/docs/WebhookEndpointDto.md +38 -0
- package/docs/WebhookEndpointWithSecretDto.md +40 -0
- package/docs/WebhookTestResultDto.md +24 -0
- package/index.ts +2 -2
- package/models/acceptance-result-response-dto.ts +2 -2
- package/models/acknowledge-product-receipt200-response.ts +2 -6
- package/models/acknowledge-products-request-dto.ts +2 -2
- package/models/api-catalog-dto.ts +2 -2
- package/models/api-catalog-entry-dto.ts +2 -2
- package/models/api-catalog-link-dto.ts +2 -2
- package/models/authorization-server-metadata-dto.ts +2 -2
- package/models/award-method-public.ts +2 -2
- package/models/award-registered-v2-response-dto.ts +2 -2
- package/models/award-reverted-v2-response-dto.ts +2 -2
- package/models/bid-acceptance-dto.ts +2 -2
- package/models/bid-attachment-input-dto.ts +2 -2
- package/models/bid-bond-dto.ts +2 -2
- package/models/bid-cancelled-response-dto.ts +2 -2
- package/models/bid-contact-dto.ts +2 -2
- package/models/bid-contacts-dto.ts +2 -2
- package/models/bid-contract-document-dto.ts +2 -2
- package/models/bid-delivery-terms-dto.ts +2 -2
- package/models/bid-detail-response-dto.ts +2 -2
- package/models/bid-document-dto.ts +2 -2
- package/models/bid-failed-v2-response-dto.ts +2 -2
- package/models/bid-item-dto.ts +2 -2
- package/models/bid-lifecycle-dto.ts +2 -2
- package/models/bid-manager-dto.ts +2 -2
- package/models/bid-payment-terms-dto.ts +2 -2
- package/models/bid-product-dto.ts +2 -2
- package/models/bid-public-status.ts +2 -2
- package/models/bid-registered-response-dto.ts +2 -2
- package/models/bid-result-participant-attachment-dto.ts +2 -2
- package/models/bid-result-participant-dto.ts +2 -2
- package/models/bid-results-response-dto.ts +2 -2
- package/models/bid-settlement-line-item-dto.ts +2 -2
- package/models/bid-settlement-participant-dto.ts +2 -2
- package/models/bid-settlement-response-dto.ts +2 -2
- package/models/bid-statement-response-dto.ts +2 -2
- package/models/bid-summary-dto.ts +2 -2
- package/models/bid-type-public.ts +2 -2
- package/models/bid-updated-response-dto.ts +2 -2
- package/models/cancel-bid-request-dto.ts +2 -2
- package/models/cancel-bid200-response.ts +2 -6
- package/models/card-payment-request-response-dto.ts +2 -2
- package/models/complete-acceptance-request-dto.ts +2 -2
- package/models/complete-acceptance200-response.ts +2 -6
- package/models/complete-invoice200-response.ts +2 -6
- package/models/complete-upload-request-dto.ts +2 -2
- package/models/contract-restriction-confirm-input-dto.ts +2 -2
- package/models/create-bid-request-dto.ts +2 -2
- package/models/create-card-payment-dto.ts +2 -2
- package/models/create-card-payment-request-dto.ts +2 -2
- package/models/create-card-payment200-response.ts +2 -6
- package/models/create-embed-launch201-response.ts +2 -6
- package/models/create-external-contract-documents-request-dto.ts +2 -2
- package/models/create-external-contract-documents-response-dto.ts +2 -2
- package/models/create-file-upload-url201-response.ts +2 -6
- package/models/create-upload-url-request-dto.ts +2 -2
- package/models/create-webhook-endpoint-request-dto.ts +30 -0
- package/models/create-webhook-endpoint201-response.ts +23 -0
- package/models/delivery-date-type-public.ts +2 -2
- package/models/delivery-method-public.ts +2 -2
- package/models/embed-launch-request-dto.ts +2 -2
- package/models/embed-launch-response-dto.ts +2 -2
- package/models/excellent-procurement-public.ts +2 -2
- package/models/external-contract-document-item-dto.ts +2 -2
- package/models/external-contract-documents-response-dto.ts +2 -2
- package/models/external-contract-item-dto.ts +2 -2
- package/models/external-contract-snapshot-dto.ts +2 -2
- package/models/external-document-inputs-dto.ts +2 -2
- package/models/file-meta-response-dto.ts +2 -2
- package/models/file-uploaded-response-dto.ts +2 -2
- package/models/generated-external-contract-document-dto.ts +2 -2
- package/models/get-bid-settlement200-response.ts +2 -6
- package/models/get-bid-statement200-response.ts +2 -6
- package/models/get-bid200-response.ts +2 -6
- package/models/get-file-meta200-response.ts +2 -6
- package/models/get-supplier-card-payable-v2200-response.ts +2 -6
- package/models/get-webhook-endpoint200-response.ts +23 -0
- package/models/green-product-public.ts +2 -2
- package/models/health-controller-check200-response.ts +2 -6
- package/models/health-response-dto.ts +2 -2
- package/models/hierarchical-region-dto.ts +2 -2
- package/models/index.ts +16 -1
- package/models/introspect-request-dto.ts +2 -2
- package/models/introspection-response-dto.ts +2 -2
- package/models/invalid-param-dto.ts +2 -2
- package/models/invoice-completed-response-dto.ts +2 -2
- package/models/invoice-split-response-dto.ts +2 -2
- package/models/legal-mandatory-public.ts +2 -2
- package/models/list-bid-results200-response.ts +6 -6
- package/models/list-bids200-response-meta.ts +30 -0
- package/models/list-bids200-response.ts +8 -8
- package/models/list-products200-response.ts +6 -6
- package/models/list-webhook-deliveries-response-dto.ts +30 -0
- package/models/list-webhook-deliveries200-response.ts +23 -0
- package/models/list-webhook-endpoints200-response.ts +27 -0
- package/models/mark-bid-failed-request-dto.ts +2 -2
- package/models/mark-bid-failed201-response.ts +2 -6
- package/models/negotiation-score-dto.ts +2 -2
- package/models/negotiation-scored-v2-response-dto.ts +2 -2
- package/models/oauth-error-response-dto.ts +2 -2
- package/models/partner-webhook-delivery-status.ts +28 -0
- package/models/partner-webhook-endpoint-status.ts +29 -0
- package/models/partner-webhook-event-type.ts +32 -0
- package/models/payment-method-public.ts +2 -2
- package/models/preconditions-dto.ts +2 -2
- package/models/problem-details-dto.ts +2 -2
- package/models/product-receipt-response-dto.ts +2 -2
- package/models/product-response-dto.ts +2 -2
- package/models/protected-resource-metadata-dto.ts +2 -2
- package/models/register-award-request-dto.ts +2 -2
- package/models/register-award201-response.ts +2 -6
- package/models/register-bid201-response.ts +2 -6
- package/models/register-semo-contract-request-dto.ts +2 -2
- package/models/request-invoice-split-request-dto.ts +2 -2
- package/models/request-invoice-split200-response.ts +2 -6
- package/models/retiree-roster-input-dto.ts +2 -2
- package/models/retiree-roster-row-dto.ts +2 -2
- package/models/revert-award-request-dto.ts +2 -2
- package/models/revert-award200-response.ts +2 -6
- package/models/revoke-request-dto.ts +2 -2
- package/models/semo-contract-registered-response-dto.ts +2 -2
- package/models/semo-contract-taxinvoice-status-response-dto.ts +2 -2
- package/models/send-webhook-test-event200-response.ts +23 -0
- package/models/statement-document-dto.ts +2 -2
- package/models/statement-product-dto.ts +2 -2
- package/models/submit-negotiation-scores-request-dto.ts +2 -2
- package/models/submit-negotiation-scores201-response.ts +2 -6
- package/models/supplier-card-payable-response-dto.ts +2 -2
- package/models/supplier-tax-type.ts +2 -2
- package/models/token-request-dto.ts +2 -2
- package/models/token-response-dto.ts +2 -2
- package/models/update-bid-request-dto.ts +2 -2
- package/models/update-bid200-response.ts +2 -6
- package/models/update-webhook-endpoint-request-dto.ts +39 -0
- package/models/upload-file-request-dto.ts +2 -2
- package/models/upload-file201-response.ts +2 -6
- package/models/upload-url-created-response-dto.ts +2 -2
- package/models/webhook-delivery-dto.ts +82 -0
- package/models/webhook-endpoint-dto.ts +67 -0
- package/models/webhook-endpoint-with-secret-dto.ts +71 -0
- package/models/webhook-test-result-dto.ts +31 -0
- package/package.json +1 -1
- package/dist/esm/models/list-bids-response-dto.d.ts +0 -22
- package/dist/esm/models/list-bids-response-dto.js +0 -14
- package/dist/models/list-bids-response-dto.d.ts +0 -22
- package/dist/models/list-bids-response-dto.js +0 -15
- package/models/list-bids-response-dto.ts +0 -30
package/docs/PartnerApiApi.md
CHANGED
|
@@ -11,6 +11,8 @@ All URIs are relative to *https://partner-api.c-market.net*
|
|
|
11
11
|
|[**createCardPayment**](#createcardpayment) | **POST** /v2/card-payments | 결제창 발행|
|
|
12
12
|
|[**createExternalContractDocuments**](#createexternalcontractdocuments) | **POST** /v2/contract-documents | 계약서류 생성|
|
|
13
13
|
|[**createFileUploadUrl**](#createfileuploadurl) | **POST** /v2/files/upload-url | 대용량 업로드 1/2 — 업로드 주소 발급|
|
|
14
|
+
|[**createWebhookEndpoint**](#createwebhookendpoint) | **POST** /v2/webhook-endpoints | 웹훅 구독 등록|
|
|
15
|
+
|[**deleteWebhookEndpoint**](#deletewebhookendpoint) | **DELETE** /v2/webhook-endpoints/{endpointId} | 웹훅 구독 삭제|
|
|
14
16
|
|[**downloadFile**](#downloadfile) | **GET** /files/{fileKey} | 파일 다운로드|
|
|
15
17
|
|[**getBid**](#getbid) | **GET** /v2/bids/{bidRef} | 공고 상세 조회|
|
|
16
18
|
|[**getBidSettlement**](#getbidsettlement) | **GET** /v2/bids/{bidRef}/settlement | 정산 정보 조회|
|
|
@@ -18,18 +20,24 @@ All URIs are relative to *https://partner-api.c-market.net*
|
|
|
18
20
|
|[**getFileMeta**](#getfilemeta) | **GET** /v2/files/{fileKey} | 파일 정보 조회|
|
|
19
21
|
|[**getSemoContractTaxinvoiceStatus**](#getsemocontracttaxinvoicestatus) | **GET** /v2/semo-contracts/{externalContractId}/tax-invoice | 계산서 발행 상태 조회|
|
|
20
22
|
|[**getSupplierCardPayableV2**](#getsuppliercardpayablev2) | **GET** /v2/suppliers/{memberId}/card-payable | 공급사 카드결제 가능 여부|
|
|
23
|
+
|[**getWebhookEndpoint**](#getwebhookendpoint) | **GET** /v2/webhook-endpoints/{endpointId} | 웹훅 구독 단건 조회|
|
|
21
24
|
|[**healthControllerCheck**](#healthcontrollercheck) | **GET** /health | Partner API 헬스체크|
|
|
22
25
|
|[**listBidResults**](#listbidresults) | **GET** /v2/bid-results | 공고 결과 조회|
|
|
23
26
|
|[**listBids**](#listbids) | **GET** /v2/bids | 공고 목록 조회|
|
|
24
27
|
|[**listExternalContractDocuments**](#listexternalcontractdocuments) | **GET** /v2/contract-documents | 거래에 필요한 계약서류 목록 조회|
|
|
28
|
+
|[**listWebhookDeliveries**](#listwebhookdeliveries) | **GET** /v2/webhook-deliveries | 웹훅 전송 이력 조회|
|
|
29
|
+
|[**listWebhookEndpoints**](#listwebhookendpoints) | **GET** /v2/webhook-endpoints | 웹훅 구독 목록 조회|
|
|
25
30
|
|[**markBidFailed**](#markbidfailed) | **POST** /v2/bids/{bidRef}/fail | 유찰 처리|
|
|
26
31
|
|[**registerAward**](#registeraward) | **POST** /v2/bids/{bidRef}/award | 낙찰 결과 전송|
|
|
27
32
|
|[**registerBid**](#registerbid) | **POST** /v2/bids | 공고 등록|
|
|
28
33
|
|[**registerSemoContract**](#registersemocontract) | **POST** /v2/semo-contracts | 계약 발행대상 등록|
|
|
29
34
|
|[**requestInvoiceSplit**](#requestinvoicesplit) | **POST** /v2/bids/{bidRef}/invoice-splits | 계산서 분할 발급 청구|
|
|
30
35
|
|[**revertAward**](#revertaward) | **DELETE** /v2/bids/{bidRef}/award | 낙찰 되돌리기|
|
|
36
|
+
|[**rotateWebhookSecret**](#rotatewebhooksecret) | **POST** /v2/webhook-endpoints/{endpointId}/rotate-secret | 웹훅 서명 시크릿 재발급|
|
|
37
|
+
|[**sendWebhookTestEvent**](#sendwebhooktestevent) | **POST** /v2/webhook-endpoints/{endpointId}/test | 웹훅 연결 확인 발송|
|
|
31
38
|
|[**submitNegotiationScores**](#submitnegotiationscores) | **POST** /v2/bids/{bidRef}/negotiation-scores | 협상 점수평가|
|
|
32
39
|
|[**updateBid**](#updatebid) | **PATCH** /v2/bids/{bidRef} | 공고 수정|
|
|
40
|
+
|[**updateWebhookEndpoint**](#updatewebhookendpoint) | **PATCH** /v2/webhook-endpoints/{endpointId} | 웹훅 구독 수정|
|
|
33
41
|
|[**uploadFile**](#uploadfile) | **POST** /v2/files | 공고 첨부파일 업로드 (기본)|
|
|
34
42
|
|
|
35
43
|
# **cancelBid**
|
|
@@ -488,6 +496,138 @@ const { status, data } = await apiInstance.createFileUploadUrl(
|
|
|
488
496
|
|
|
489
497
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
490
498
|
|
|
499
|
+
# **createWebhookEndpoint**
|
|
500
|
+
> CreateWebhookEndpoint201Response createWebhookEndpoint(createWebhookEndpointRequestDto)
|
|
501
|
+
|
|
502
|
+
수신 주소와 구독할 이벤트를 등록합니다. **호출 시점:** 연동 초기 1회. 수신 주소가 바뀌면 새로 만들지 말고 `PATCH` 로 고치세요 — 그래야 시크릿과 전송 이력이 유지됩니다. **서명 시크릿은 이 응답에서 한 번만 나갑니다.** 서버는 해시만 보관하므로 조회로 다시 받을 수 없습니다. 응답의 `secret` 을 즉시 안전한 곳에 보관하세요. 잃어버렸다면 복구가 아니라 `POST /v2/webhook-endpoints/{endpointId}/rotate-secret` 으로 **재발급**해야 합니다. **거절되는 경우와 고치는 법:** - `400` — `url` 이 HTTPS 가 아니거나 형식이 잘못됨, `eventTypes` 가 비었거나 목록 밖 값 (`ping` 은 구독 불가). 값을 고쳐 재시도하세요. - `400` — `Idempotency-Key` 헤더 누락/형식 오류. UUID v4 를 실어 보내세요. - `403` — 토큰에 `webhooks:write` 스코프가 없음. 키 발급 설정을 넓혀야 합니다. **필수 스코프:** `webhooks:write` **멱등성:** `Idempotency-Key` 헤더 필수. ### 서명 검증 (필수) 서명은 **[Standard Webhooks](https://www.standardwebhooks.com)** 규약을 그대로 따릅니다. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리에 등록 시 받은 시크릿 (`whsec_…`)을 그대로 넘기세요 — 그것이 이 형식을 쓰는 이유입니다. ```java // Java Webhook webhook = new Webhook(secret); // secret = \"whsec_…\" webhook.verify(rawBody, headers); // 실패하면 예외 ``` ```ts // Node / TypeScript import { Webhook } from \'standardwebhooks\'; new Webhook(secret).verify(rawBody, headers); ``` 라이브러리를 쓸 수 없다면 발송 요청에 실리는 헤더는 셋입니다. ``` webhook-id: evt_01J8Z7Q3K9 webhook-timestamp: 1774915200 webhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4= ``` 1. 시크릿에서 `whsec_` 접두어를 떼고 **base64 디코드**합니다 — 그 바이트가 HMAC 키입니다 (시크릿 문자열 자체가 아닙니다). 2. `\"${webhook-id}.${webhook-timestamp}.${본문 원문}\"` 을 만듭니다. **본문은 파싱 전 원문 바이트**여야 합니다 — JSON 을 다시 직렬화하면 공백·키 순서가 달라져 서명이 맞지 않습니다. 3. HMAC-SHA256 을 계산해 **base64** 로 인코딩하고, `webhook-signature` 의 `v1,` 뒤 값과 비교합니다. 비교는 **상수 시간** 함수를 쓰세요(Node `crypto.timingSafeEqual`, Java `MessageDigest.isEqual`). 4. `webhook-timestamp` 가 현재 시각에서 **5분** 이상 지났으면 거절하세요(재전송 공격 방어). `webhook-signature` 는 공백으로 구분된 **여러 서명**을 실을 수 있는 형식입니다(키 회전용). 지금은 항상 하나지만, 검증기는 목록으로 읽고 **하나라도 맞으면 통과**하도록 짜세요. ### 중복 제거 `webhook-id` 헤더가 이벤트 식별자입니다. **재시도에도 같은 값이 옵니다** — 이미 처리한 값이면 무시하세요. 같은 이벤트를 두 번 받는 것은 정상 동작이며, 중복 제거는 수신측 책임입니다. 편의를 위해 `webhook-event-type` 헤더에 이벤트 타입(본문 `type` 과 같은 값)도 실립니다 — 본문을 파싱하기 전에 관심 없는 타입을 버릴 수 있습니다. 표준에는 없는 확장이라 검증 라이브러리는 이 헤더를 무시합니다. ### 응답과 재시도 2xx 를 돌려주면 성공입니다. 그 외(또는 무응답)는 실패로 보고 최대 7회 재시도합니다 — 간격은 10초 → 1분 → 5분 → 30분 → 2시간 → 6시간 → 24시간 입니다. 처리 시간이 길면 먼저 2xx 를 돌려주고 비동기로 처리하세요. 연속 실패가 20회에 닿으면 구독이 자동으로 `DISABLED` 로 내려가고 발송이 멈춥니다. 수신측을 고친 뒤 `PATCH /v2/webhook-endpoints/{endpointId}` 에 `{\"status\":\"ACTIVE\"}` 로 되살리세요. ### 구독 가능한 이벤트 `bid.closed` · `bid.awarded` · `bid.failed` · `bid.canceled` · `bid.award_reverted` `ping` 은 연결 확인 전용이라 구독할 수 없습니다 — 테스트 발송 경로에서만 나갑니다. ### 놓친 이벤트 확인 `GET /v2/webhook-deliveries` 가 발송 시도 이력(본문·응답 상태·다음 재시도 시각)을 돌려줍니다. 수신측 장애 구간을 메울 때 이 엔드포인트를 폴링 대체 경로로 쓰세요.
|
|
503
|
+
|
|
504
|
+
### Example
|
|
505
|
+
|
|
506
|
+
```typescript
|
|
507
|
+
import {
|
|
508
|
+
PartnerApiApi,
|
|
509
|
+
Configuration,
|
|
510
|
+
CreateWebhookEndpointRequestDto
|
|
511
|
+
} from '@cmarket/partner-sdk';
|
|
512
|
+
|
|
513
|
+
const configuration = new Configuration();
|
|
514
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
515
|
+
|
|
516
|
+
let idempotencyKey: string; //멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. (default to undefined)
|
|
517
|
+
let createWebhookEndpointRequestDto: CreateWebhookEndpointRequestDto; //
|
|
518
|
+
|
|
519
|
+
const { status, data } = await apiInstance.createWebhookEndpoint(
|
|
520
|
+
idempotencyKey,
|
|
521
|
+
createWebhookEndpointRequestDto
|
|
522
|
+
);
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
|Name | Type | Description | Notes|
|
|
528
|
+
|------------- | ------------- | ------------- | -------------|
|
|
529
|
+
| **createWebhookEndpointRequestDto** | **CreateWebhookEndpointRequestDto**| | |
|
|
530
|
+
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. | defaults to undefined|
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
**CreateWebhookEndpoint201Response**
|
|
536
|
+
|
|
537
|
+
### Authorization
|
|
538
|
+
|
|
539
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
540
|
+
|
|
541
|
+
### HTTP request headers
|
|
542
|
+
|
|
543
|
+
- **Content-Type**: application/json
|
|
544
|
+
- **Accept**: application/json, application/problem+json
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
### HTTP response details
|
|
548
|
+
| Status code | Description | Response headers |
|
|
549
|
+
|-------------|-------------|------------------|
|
|
550
|
+
|**201** | 구독 등록 완료. `secret` 은 이 응답에만 실립니다. | - |
|
|
551
|
+
|**400** | 입력 검증 실패(`type: …/validation-failed`), Idempotency-Key 헤더 누락/형식 오류(`…/idempotency-key-required`, `…/idempotency-key-invalid`), 또는 요청 내용이 유효하지 않음(`…/upstream-invalid-input`). | - |
|
|
552
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
553
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
554
|
+
|**409** | 원 요청이 아직 처리 중인 상태에서 같은 Idempotency-Key 재전송(`type: …/idempotency-key-conflict` — 잠시 뒤 같은 키로 재시도하면 결과를 받는다) 또는 현재 상태와 충돌하는 요청(`…/upstream-conflict`). | - |
|
|
555
|
+
|**422** | 동일 Idempotency-Key 를 **다른 body** 로 재전송(`type: …/idempotency-key-reused`). 재시도해도 동일 실패 — 새 키를 쓰거나 body 를 원래대로 되돌려야 한다. 형식은 맞지만 내용상 처리할 수 없는 요청(`…/upstream-unprocessable`)도 이 상태다. | - |
|
|
556
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
557
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
558
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
559
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
560
|
+
|
|
561
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
562
|
+
|
|
563
|
+
# **deleteWebhookEndpoint**
|
|
564
|
+
> deleteWebhookEndpoint()
|
|
565
|
+
|
|
566
|
+
구독을 삭제합니다. 이후 그 주소로는 아무 이벤트도 발송되지 않습니다. **호출 시점:** 연동을 종료할 때. 잠시만 멈추려면 삭제하지 말고 `PATCH … {\"status\":\"DISABLED\"}` 를 쓰세요 — 시크릿과 이벤트 구성이 남아 그대로 되살릴 수 있습니다. **되돌릴 수 없습니다.** 다시 등록하면 새 구독이고 서명 시크릿도 새 값입니다. **`If-Match` 가 필수입니다.** `GET` 으로 받은 `ETag` 를 실어 보내세요. - `428` — 헤더 누락. 조회 후 재시도하세요. - `412` — 그 사이 구독이 바뀌었습니다(누군가 수정했거나 발송기가 상태를 내렸습니다). 다시 조회해 정말 지울 대상이 맞는지 확인하고 최신 `ETag` 로 재시도하세요. **필수 스코프:** `webhooks:write` **멱등성:** `Idempotency-Key` 헤더 필수.
|
|
567
|
+
|
|
568
|
+
### Example
|
|
569
|
+
|
|
570
|
+
```typescript
|
|
571
|
+
import {
|
|
572
|
+
PartnerApiApi,
|
|
573
|
+
Configuration
|
|
574
|
+
} from '@cmarket/partner-sdk';
|
|
575
|
+
|
|
576
|
+
const configuration = new Configuration();
|
|
577
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
578
|
+
|
|
579
|
+
let endpointId: string; //구독 식별자(등록 응답의 `endpointId`). (default to undefined)
|
|
580
|
+
let ifMatch: string; //직전 조회 응답의 `ETag` 값. 누락하면 428, 그 사이 구독이 바뀌었으면 412 로 거절되며 아무것도 변경되지 않습니다. (default to undefined)
|
|
581
|
+
let idempotencyKey: string; //멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. (default to undefined)
|
|
582
|
+
|
|
583
|
+
const { status, data } = await apiInstance.deleteWebhookEndpoint(
|
|
584
|
+
endpointId,
|
|
585
|
+
ifMatch,
|
|
586
|
+
idempotencyKey
|
|
587
|
+
);
|
|
588
|
+
```
|
|
589
|
+
|
|
590
|
+
### Parameters
|
|
591
|
+
|
|
592
|
+
|Name | Type | Description | Notes|
|
|
593
|
+
|------------- | ------------- | ------------- | -------------|
|
|
594
|
+
| **endpointId** | [**string**] | 구독 식별자(등록 응답의 `endpointId`). | defaults to undefined|
|
|
595
|
+
| **ifMatch** | [**string**] | 직전 조회 응답의 `ETag` 값. 누락하면 428, 그 사이 구독이 바뀌었으면 412 로 거절되며 아무것도 변경되지 않습니다. | defaults to undefined|
|
|
596
|
+
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. | defaults to undefined|
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
void (empty response body)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: application/problem+json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
|**204** | 구독 삭제 완료(본문 없음). | - |
|
|
617
|
+
|**400** | 입력 검증 실패(`type: …/validation-failed`), Idempotency-Key 헤더 누락/형식 오류(`…/idempotency-key-required`, `…/idempotency-key-invalid`), 또는 요청 내용이 유효하지 않음(`…/upstream-invalid-input`). | - |
|
|
618
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
619
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
620
|
+
|**409** | 원 요청이 아직 처리 중인 상태에서 같은 Idempotency-Key 재전송(`type: …/idempotency-key-conflict` — 잠시 뒤 같은 키로 재시도하면 결과를 받는다) 또는 현재 상태와 충돌하는 요청(`…/upstream-conflict`). | - |
|
|
621
|
+
|**412** | `If-Match` 지문이 현재 리소스와 다릅니다(`type: …/precondition-failed`). 그 사이 다른 요청이 리소스를 바꿨습니다 — 다시 조회해 최신 ETag 로 재시도하세요. | - |
|
|
622
|
+
|**422** | 동일 Idempotency-Key 를 **다른 body** 로 재전송(`type: …/idempotency-key-reused`). 재시도해도 동일 실패 — 새 키를 쓰거나 body 를 원래대로 되돌려야 한다. 형식은 맞지만 내용상 처리할 수 없는 요청(`…/upstream-unprocessable`)도 이 상태다. | - |
|
|
623
|
+
|**428** | `If-Match` 헤더가 없습니다(`type: …/if-match-required`). 잃어버린 갱신을 막기 위해 필수입니다. | - |
|
|
624
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
625
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
626
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
627
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
628
|
+
|
|
629
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
630
|
+
|
|
491
631
|
# **downloadFile**
|
|
492
632
|
> downloadFile()
|
|
493
633
|
|
|
@@ -888,6 +1028,65 @@ const { status, data } = await apiInstance.getSupplierCardPayableV2(
|
|
|
888
1028
|
|
|
889
1029
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
890
1030
|
|
|
1031
|
+
# **getWebhookEndpoint**
|
|
1032
|
+
> GetWebhookEndpoint200Response getWebhookEndpoint()
|
|
1033
|
+
|
|
1034
|
+
구독 1건의 현재 상태를 조회합니다. 서명 시크릿은 실리지 않습니다. **수정·삭제 전에 먼저 호출하세요.** 응답 헤더 `ETag` 를 `If-Match` 에 그대로 실어야 `PATCH`/`DELETE` 가 통과합니다. **`404`:** 없는 구독이거나 다른 파트너 키의 구독입니다 — `endpointId` 를 확인하세요. **필수 스코프:** `webhooks:read`
|
|
1035
|
+
|
|
1036
|
+
### Example
|
|
1037
|
+
|
|
1038
|
+
```typescript
|
|
1039
|
+
import {
|
|
1040
|
+
PartnerApiApi,
|
|
1041
|
+
Configuration
|
|
1042
|
+
} from '@cmarket/partner-sdk';
|
|
1043
|
+
|
|
1044
|
+
const configuration = new Configuration();
|
|
1045
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1046
|
+
|
|
1047
|
+
let endpointId: string; //구독 식별자(등록 응답의 `endpointId`). (default to undefined)
|
|
1048
|
+
|
|
1049
|
+
const { status, data } = await apiInstance.getWebhookEndpoint(
|
|
1050
|
+
endpointId
|
|
1051
|
+
);
|
|
1052
|
+
```
|
|
1053
|
+
|
|
1054
|
+
### Parameters
|
|
1055
|
+
|
|
1056
|
+
|Name | Type | Description | Notes|
|
|
1057
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1058
|
+
| **endpointId** | [**string**] | 구독 식별자(등록 응답의 `endpointId`). | defaults to undefined|
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
### Return type
|
|
1062
|
+
|
|
1063
|
+
**GetWebhookEndpoint200Response**
|
|
1064
|
+
|
|
1065
|
+
### Authorization
|
|
1066
|
+
|
|
1067
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1068
|
+
|
|
1069
|
+
### HTTP request headers
|
|
1070
|
+
|
|
1071
|
+
- **Content-Type**: Not defined
|
|
1072
|
+
- **Accept**: application/json, application/problem+json
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
### HTTP response details
|
|
1076
|
+
| Status code | Description | Response headers |
|
|
1077
|
+
|-------------|-------------|------------------|
|
|
1078
|
+
|**200** | 웹훅 구독 상세. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
1079
|
+
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
1080
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1081
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
1082
|
+
|**404** | 대상을 찾을 수 없습니다(`type: …/upstream-not-found`). | - |
|
|
1083
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
1084
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
1085
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
1086
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
1087
|
+
|
|
1088
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1089
|
+
|
|
891
1090
|
# **healthControllerCheck**
|
|
892
1091
|
> HealthControllerCheck200Response healthControllerCheck()
|
|
893
1092
|
|
|
@@ -981,7 +1180,7 @@ const { status, data } = await apiInstance.listBidResults(
|
|
|
981
1180
|
### HTTP response details
|
|
982
1181
|
| Status code | Description | Response headers |
|
|
983
1182
|
|-------------|-------------|------------------|
|
|
984
|
-
|**200** |
|
|
1183
|
+
|**200** | 요청한 공고의 응찰 결과 목록. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
985
1184
|
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
986
1185
|
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
987
1186
|
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
@@ -996,7 +1195,7 @@ const { status, data } = await apiInstance.listBidResults(
|
|
|
996
1195
|
# **listBids**
|
|
997
1196
|
> ListBids200Response listBids()
|
|
998
1197
|
|
|
999
|
-
발주처(API 키 바인딩)의 공고를 게시일 최신순으로 조회합니다. 스코프 `bids:read`. **발주처:** API 키에 바인딩된 발주처로 자동 스코프됩니다(쿼리에 buyerId 를 넣지 않습니다). **페이지네이션(cursor):** `limit`(1~100, 기본 100) + `cursor`(불투명 토큰).
|
|
1198
|
+
발주처(API 키 바인딩)의 공고를 게시일 최신순으로 조회합니다. 스코프 `bids:read`. **발주처:** API 키에 바인딩된 발주처로 자동 스코프됩니다(쿼리에 buyerId 를 넣지 않습니다). **페이지네이션(cursor):** `limit`(1~100, 기본 100) + `cursor`(불투명 토큰). 응답 `meta.nextCursor` 를 다음 요청 `cursor` 로 전달하면 다음 페이지를 받습니다. `meta.hasMore` 가 `false`(= `nextCursor` 가 `null`)이면 마지막 페이지입니다. 목록 자체는 `data` 에 배열로 실립니다. **상태·낙찰방법:** 공개값(의미 문자열)으로 반환됩니다. 낙찰 여부는 상태가 아니라 낙찰 결과 조회의 `participants[].isWinner` 로 관측합니다(AWARDED 상태는 없습니다).
|
|
1000
1199
|
|
|
1001
1200
|
### Example
|
|
1002
1201
|
|
|
@@ -1052,7 +1251,7 @@ const { status, data } = await apiInstance.listBids(
|
|
|
1052
1251
|
### HTTP response details
|
|
1053
1252
|
| Status code | Description | Response headers |
|
|
1054
1253
|
|-------------|-------------|------------------|
|
|
1055
|
-
|**200** |
|
|
1254
|
+
|**200** | 공고 요약 목록. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
1056
1255
|
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
1057
1256
|
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1058
1257
|
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
@@ -1126,6 +1325,126 @@ const { status, data } = await apiInstance.listExternalContractDocuments(
|
|
|
1126
1325
|
|
|
1127
1326
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1128
1327
|
|
|
1328
|
+
# **listWebhookDeliveries**
|
|
1329
|
+
> ListWebhookDeliveries200Response listWebhookDeliveries()
|
|
1330
|
+
|
|
1331
|
+
이 API 키의 웹훅 발송 시도를 최신순으로 조회합니다. 보낸 본문·수신측 응답 상태· 다음 재시도 예정 시각이 함께 실립니다. **호출 시점:** - 수신측 장애로 놓친 이벤트를 메울 때. 이 엔드포인트가 웹훅의 **폴링 대체 경로**입니다 — `status=EXHAUSTED` 로 걸러 다시 처리하면 됩니다. - \"이벤트가 안 온다\" 를 진단할 때. 발송 시도 자체가 없는지(구독·이벤트 타입 문제), 시도했지만 실패했는지(`responseStatus`·`responseBodyExcerpt`)를 여기서 가릅니다. **같은 이벤트가 여러 행으로 보입니다.** 재시도마다 한 행이며 `eventId` 가 같고 `attempt` 만 올라갑니다. 처리 여부는 `eventId` 기준으로 판단하세요. **페이지네이션:** `nextCursor` 를 다음 요청의 `cursor` 로 전달합니다. null 이면 마지막 페이지입니다. **`400`:** `status` 가 허용 값 밖이거나 `limit` 이 범위를 벗어났습니다 — 값을 고쳐 재시도하세요. **필수 스코프:** `webhooks:read`
|
|
1332
|
+
|
|
1333
|
+
### Example
|
|
1334
|
+
|
|
1335
|
+
```typescript
|
|
1336
|
+
import {
|
|
1337
|
+
PartnerApiApi,
|
|
1338
|
+
Configuration
|
|
1339
|
+
} from '@cmarket/partner-sdk';
|
|
1340
|
+
|
|
1341
|
+
const configuration = new Configuration();
|
|
1342
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1343
|
+
|
|
1344
|
+
let endpointId: string; //이 구독의 전송만 조회합니다. 미지정이면 이 키의 모든 구독을 함께 조회합니다. (optional) (default to undefined)
|
|
1345
|
+
let status: PartnerWebhookDeliveryStatus; //전송 상태 필터. 미지정이면 전부. (optional) (default to undefined)
|
|
1346
|
+
let limit: number; //페이지 크기(1~200, 기본 50). (optional) (default to 50)
|
|
1347
|
+
let cursor: string; //다음 페이지 커서(불투명 토큰). 직전 응답의 `nextCursor` 를 그대로 전달합니다. 미지정 시 첫 페이지. (optional) (default to undefined)
|
|
1348
|
+
|
|
1349
|
+
const { status, data } = await apiInstance.listWebhookDeliveries(
|
|
1350
|
+
endpointId,
|
|
1351
|
+
status,
|
|
1352
|
+
limit,
|
|
1353
|
+
cursor
|
|
1354
|
+
);
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
### Parameters
|
|
1358
|
+
|
|
1359
|
+
|Name | Type | Description | Notes|
|
|
1360
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1361
|
+
| **endpointId** | [**string**] | 이 구독의 전송만 조회합니다. 미지정이면 이 키의 모든 구독을 함께 조회합니다. | (optional) defaults to undefined|
|
|
1362
|
+
| **status** | **PartnerWebhookDeliveryStatus** | 전송 상태 필터. 미지정이면 전부. | (optional) defaults to undefined|
|
|
1363
|
+
| **limit** | [**number**] | 페이지 크기(1~200, 기본 50). | (optional) defaults to 50|
|
|
1364
|
+
| **cursor** | [**string**] | 다음 페이지 커서(불투명 토큰). 직전 응답의 `nextCursor` 를 그대로 전달합니다. 미지정 시 첫 페이지. | (optional) defaults to undefined|
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
### Return type
|
|
1368
|
+
|
|
1369
|
+
**ListWebhookDeliveries200Response**
|
|
1370
|
+
|
|
1371
|
+
### Authorization
|
|
1372
|
+
|
|
1373
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1374
|
+
|
|
1375
|
+
### HTTP request headers
|
|
1376
|
+
|
|
1377
|
+
- **Content-Type**: Not defined
|
|
1378
|
+
- **Accept**: application/json, application/problem+json
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
### HTTP response details
|
|
1382
|
+
| Status code | Description | Response headers |
|
|
1383
|
+
|-------------|-------------|------------------|
|
|
1384
|
+
|**200** | 웹훅 전송 이력. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
1385
|
+
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
1386
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1387
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
1388
|
+
|**404** | 대상을 찾을 수 없습니다(`type: …/upstream-not-found`). | - |
|
|
1389
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
1390
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
1391
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
1392
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
1393
|
+
|
|
1394
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1395
|
+
|
|
1396
|
+
# **listWebhookEndpoints**
|
|
1397
|
+
> ListWebhookEndpoints200Response listWebhookEndpoints()
|
|
1398
|
+
|
|
1399
|
+
이 API 키가 등록한 웹훅 구독을 모두 조회합니다. **호출 시점:** 연동 상태를 점검할 때, 또는 발송이 멈춘 이유(`status`·`consecutiveFailures`)를 확인할 때. 서명 시크릿은 여기에 실리지 않습니다. **필수 스코프:** `webhooks:read` ### 서명 검증 (필수) 서명은 **[Standard Webhooks](https://www.standardwebhooks.com)** 규약을 그대로 따릅니다. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리에 등록 시 받은 시크릿 (`whsec_…`)을 그대로 넘기세요 — 그것이 이 형식을 쓰는 이유입니다. ```java // Java Webhook webhook = new Webhook(secret); // secret = \"whsec_…\" webhook.verify(rawBody, headers); // 실패하면 예외 ``` ```ts // Node / TypeScript import { Webhook } from \'standardwebhooks\'; new Webhook(secret).verify(rawBody, headers); ``` 라이브러리를 쓸 수 없다면 발송 요청에 실리는 헤더는 셋입니다. ``` webhook-id: evt_01J8Z7Q3K9 webhook-timestamp: 1774915200 webhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4= ``` 1. 시크릿에서 `whsec_` 접두어를 떼고 **base64 디코드**합니다 — 그 바이트가 HMAC 키입니다 (시크릿 문자열 자체가 아닙니다). 2. `\"${webhook-id}.${webhook-timestamp}.${본문 원문}\"` 을 만듭니다. **본문은 파싱 전 원문 바이트**여야 합니다 — JSON 을 다시 직렬화하면 공백·키 순서가 달라져 서명이 맞지 않습니다. 3. HMAC-SHA256 을 계산해 **base64** 로 인코딩하고, `webhook-signature` 의 `v1,` 뒤 값과 비교합니다. 비교는 **상수 시간** 함수를 쓰세요(Node `crypto.timingSafeEqual`, Java `MessageDigest.isEqual`). 4. `webhook-timestamp` 가 현재 시각에서 **5분** 이상 지났으면 거절하세요(재전송 공격 방어). `webhook-signature` 는 공백으로 구분된 **여러 서명**을 실을 수 있는 형식입니다(키 회전용). 지금은 항상 하나지만, 검증기는 목록으로 읽고 **하나라도 맞으면 통과**하도록 짜세요. ### 중복 제거 `webhook-id` 헤더가 이벤트 식별자입니다. **재시도에도 같은 값이 옵니다** — 이미 처리한 값이면 무시하세요. 같은 이벤트를 두 번 받는 것은 정상 동작이며, 중복 제거는 수신측 책임입니다. 편의를 위해 `webhook-event-type` 헤더에 이벤트 타입(본문 `type` 과 같은 값)도 실립니다 — 본문을 파싱하기 전에 관심 없는 타입을 버릴 수 있습니다. 표준에는 없는 확장이라 검증 라이브러리는 이 헤더를 무시합니다. ### 응답과 재시도 2xx 를 돌려주면 성공입니다. 그 외(또는 무응답)는 실패로 보고 최대 7회 재시도합니다 — 간격은 10초 → 1분 → 5분 → 30분 → 2시간 → 6시간 → 24시간 입니다. 처리 시간이 길면 먼저 2xx 를 돌려주고 비동기로 처리하세요. 연속 실패가 20회에 닿으면 구독이 자동으로 `DISABLED` 로 내려가고 발송이 멈춥니다. 수신측을 고친 뒤 `PATCH /v2/webhook-endpoints/{endpointId}` 에 `{\"status\":\"ACTIVE\"}` 로 되살리세요. ### 구독 가능한 이벤트 `bid.closed` · `bid.awarded` · `bid.failed` · `bid.canceled` · `bid.award_reverted` `ping` 은 연결 확인 전용이라 구독할 수 없습니다 — 테스트 발송 경로에서만 나갑니다. ### 놓친 이벤트 확인 `GET /v2/webhook-deliveries` 가 발송 시도 이력(본문·응답 상태·다음 재시도 시각)을 돌려줍니다. 수신측 장애 구간을 메울 때 이 엔드포인트를 폴링 대체 경로로 쓰세요.
|
|
1400
|
+
|
|
1401
|
+
### Example
|
|
1402
|
+
|
|
1403
|
+
```typescript
|
|
1404
|
+
import {
|
|
1405
|
+
PartnerApiApi,
|
|
1406
|
+
Configuration
|
|
1407
|
+
} from '@cmarket/partner-sdk';
|
|
1408
|
+
|
|
1409
|
+
const configuration = new Configuration();
|
|
1410
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1411
|
+
|
|
1412
|
+
const { status, data } = await apiInstance.listWebhookEndpoints();
|
|
1413
|
+
```
|
|
1414
|
+
|
|
1415
|
+
### Parameters
|
|
1416
|
+
This endpoint does not have any parameters.
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
### Return type
|
|
1420
|
+
|
|
1421
|
+
**ListWebhookEndpoints200Response**
|
|
1422
|
+
|
|
1423
|
+
### Authorization
|
|
1424
|
+
|
|
1425
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1426
|
+
|
|
1427
|
+
### HTTP request headers
|
|
1428
|
+
|
|
1429
|
+
- **Content-Type**: Not defined
|
|
1430
|
+
- **Accept**: application/json, application/problem+json
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
### HTTP response details
|
|
1434
|
+
| Status code | Description | Response headers |
|
|
1435
|
+
|-------------|-------------|------------------|
|
|
1436
|
+
|**200** | 웹훅 구독 목록. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
1437
|
+
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
1438
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1439
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
1440
|
+
|**404** | 대상을 찾을 수 없습니다(`type: …/upstream-not-found`). | - |
|
|
1441
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
1442
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
1443
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
1444
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
1445
|
+
|
|
1446
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1447
|
+
|
|
1129
1448
|
# **markBidFailed**
|
|
1130
1449
|
> MarkBidFailed201Response markBidFailed(markBidFailedRequestDto)
|
|
1131
1450
|
|
|
@@ -1522,6 +1841,132 @@ const { status, data } = await apiInstance.revertAward(
|
|
|
1522
1841
|
|
|
1523
1842
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1524
1843
|
|
|
1844
|
+
# **rotateWebhookSecret**
|
|
1845
|
+
> CreateWebhookEndpoint201Response rotateWebhookSecret()
|
|
1846
|
+
|
|
1847
|
+
서명 시크릿을 새로 발급합니다. 응답의 `secretVersion` 이 1 올라갑니다. **호출 시점:** 시크릿을 분실했거나 유출이 의심될 때, 또는 주기적 교체 정책이 있을 때. **새 시크릿은 이 응답에서 한 번만 나갑니다.** 조회로 다시 받을 수 없습니다. **옛 시크릿은 즉시 무효입니다.** 유예 기간이 없으므로, 수신측이 새 값을 반영하기 전에 도착한 이벤트는 서명 검증에 실패합니다. 배포 순서를 이렇게 잡으세요 — ① 수신측이 옛 값과 새 값을 **둘 다** 받아들이도록 배포 → ② 이 엔드포인트 호출 → ③ 응답의 새 값을 반영 → ④ 옛 값 제거. 검증 실패로 non-2xx 를 돌려주면 실패로 집계되어 20회 연속 시 구독이 중지됩니다. **필수 스코프:** `webhooks:write` **멱등성:** `Idempotency-Key` 헤더 필수. 같은 키로 재전송하면 **새로 발급하지 않고** 처음 발급한 값을 그대로 돌려줍니다(24시간) — 네트워크 오류로 응답을 놓쳤을 때 같은 키로 다시 부르세요.
|
|
1848
|
+
|
|
1849
|
+
### Example
|
|
1850
|
+
|
|
1851
|
+
```typescript
|
|
1852
|
+
import {
|
|
1853
|
+
PartnerApiApi,
|
|
1854
|
+
Configuration
|
|
1855
|
+
} from '@cmarket/partner-sdk';
|
|
1856
|
+
|
|
1857
|
+
const configuration = new Configuration();
|
|
1858
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1859
|
+
|
|
1860
|
+
let endpointId: string; //구독 식별자(등록 응답의 `endpointId`). (default to undefined)
|
|
1861
|
+
let idempotencyKey: string; //멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. (default to undefined)
|
|
1862
|
+
|
|
1863
|
+
const { status, data } = await apiInstance.rotateWebhookSecret(
|
|
1864
|
+
endpointId,
|
|
1865
|
+
idempotencyKey
|
|
1866
|
+
);
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
### Parameters
|
|
1870
|
+
|
|
1871
|
+
|Name | Type | Description | Notes|
|
|
1872
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1873
|
+
| **endpointId** | [**string**] | 구독 식별자(등록 응답의 `endpointId`). | defaults to undefined|
|
|
1874
|
+
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. | defaults to undefined|
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
### Return type
|
|
1878
|
+
|
|
1879
|
+
**CreateWebhookEndpoint201Response**
|
|
1880
|
+
|
|
1881
|
+
### Authorization
|
|
1882
|
+
|
|
1883
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1884
|
+
|
|
1885
|
+
### HTTP request headers
|
|
1886
|
+
|
|
1887
|
+
- **Content-Type**: Not defined
|
|
1888
|
+
- **Accept**: application/json, application/problem+json
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
### HTTP response details
|
|
1892
|
+
| Status code | Description | Response headers |
|
|
1893
|
+
|-------------|-------------|------------------|
|
|
1894
|
+
|**200** | 시크릿 재발급 완료. `secret` 은 이 응답에만 실립니다. | - |
|
|
1895
|
+
|**400** | 입력 검증 실패(`type: …/validation-failed`), Idempotency-Key 헤더 누락/형식 오류(`…/idempotency-key-required`, `…/idempotency-key-invalid`), 또는 요청 내용이 유효하지 않음(`…/upstream-invalid-input`). | - |
|
|
1896
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1897
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
1898
|
+
|**409** | 원 요청이 아직 처리 중인 상태에서 같은 Idempotency-Key 재전송(`type: …/idempotency-key-conflict` — 잠시 뒤 같은 키로 재시도하면 결과를 받는다) 또는 현재 상태와 충돌하는 요청(`…/upstream-conflict`). | - |
|
|
1899
|
+
|**422** | 동일 Idempotency-Key 를 **다른 body** 로 재전송(`type: …/idempotency-key-reused`). 재시도해도 동일 실패 — 새 키를 쓰거나 body 를 원래대로 되돌려야 한다. 형식은 맞지만 내용상 처리할 수 없는 요청(`…/upstream-unprocessable`)도 이 상태다. | - |
|
|
1900
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
1901
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
1902
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
1903
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
1904
|
+
|
|
1905
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1906
|
+
|
|
1907
|
+
# **sendWebhookTestEvent**
|
|
1908
|
+
> SendWebhookTestEvent200Response sendWebhookTestEvent()
|
|
1909
|
+
|
|
1910
|
+
등록된 주소로 `ping` 이벤트를 즉시 1회 보내고 그 결과를 돌려줍니다. **호출 시점:** 구독을 등록한 직후, 수신 주소를 바꾼 직후, 방화벽·인증서를 손본 뒤. **응답은 발송 결과이지 요청 실패가 아닙니다.** 수신측이 받지 못해도 HTTP `200` 에 `delivered: false` 로 옵니다 — `responseStatus`(수신측 상태)와 `error`(연결 거부·타임아웃· TLS 오류)를 보고 원인을 좁히세요. 이 발송에도 실제 이벤트와 **똑같은 서명 헤더**가 실리므로 검증 코드를 그대로 시험할 수 있습니다. `ping` 은 구독 목록에 넣을 수 없는 타입이니, 수신측이 모르는 `eventType` 을 만나면 버리도록 짜여 있다면 이 확인만 실패할 수 있습니다. **필수 스코프:** `webhooks:write` **멱등성:** `Idempotency-Key` 헤더 필수. 다시 보내려면 **새 키**를 쓰세요 — 같은 키는 24시간 동안 직전 결과를 그대로 돌려줍니다(재발송하지 않습니다).
|
|
1911
|
+
|
|
1912
|
+
### Example
|
|
1913
|
+
|
|
1914
|
+
```typescript
|
|
1915
|
+
import {
|
|
1916
|
+
PartnerApiApi,
|
|
1917
|
+
Configuration
|
|
1918
|
+
} from '@cmarket/partner-sdk';
|
|
1919
|
+
|
|
1920
|
+
const configuration = new Configuration();
|
|
1921
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1922
|
+
|
|
1923
|
+
let endpointId: string; //구독 식별자(등록 응답의 `endpointId`). (default to undefined)
|
|
1924
|
+
let idempotencyKey: string; //멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. (default to undefined)
|
|
1925
|
+
|
|
1926
|
+
const { status, data } = await apiInstance.sendWebhookTestEvent(
|
|
1927
|
+
endpointId,
|
|
1928
|
+
idempotencyKey
|
|
1929
|
+
);
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
### Parameters
|
|
1933
|
+
|
|
1934
|
+
|Name | Type | Description | Notes|
|
|
1935
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1936
|
+
| **endpointId** | [**string**] | 구독 식별자(등록 응답의 `endpointId`). | defaults to undefined|
|
|
1937
|
+
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. | defaults to undefined|
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
### Return type
|
|
1941
|
+
|
|
1942
|
+
**SendWebhookTestEvent200Response**
|
|
1943
|
+
|
|
1944
|
+
### Authorization
|
|
1945
|
+
|
|
1946
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1947
|
+
|
|
1948
|
+
### HTTP request headers
|
|
1949
|
+
|
|
1950
|
+
- **Content-Type**: Not defined
|
|
1951
|
+
- **Accept**: application/json, application/problem+json
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
### HTTP response details
|
|
1955
|
+
| Status code | Description | Response headers |
|
|
1956
|
+
|-------------|-------------|------------------|
|
|
1957
|
+
|**200** | 연결 확인 발송 결과. | - |
|
|
1958
|
+
|**400** | 입력 검증 실패(`type: …/validation-failed`), Idempotency-Key 헤더 누락/형식 오류(`…/idempotency-key-required`, `…/idempotency-key-invalid`), 또는 요청 내용이 유효하지 않음(`…/upstream-invalid-input`). | - |
|
|
1959
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
1960
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
1961
|
+
|**409** | 원 요청이 아직 처리 중인 상태에서 같은 Idempotency-Key 재전송(`type: …/idempotency-key-conflict` — 잠시 뒤 같은 키로 재시도하면 결과를 받는다) 또는 현재 상태와 충돌하는 요청(`…/upstream-conflict`). | - |
|
|
1962
|
+
|**422** | 동일 Idempotency-Key 를 **다른 body** 로 재전송(`type: …/idempotency-key-reused`). 재시도해도 동일 실패 — 새 키를 쓰거나 body 를 원래대로 되돌려야 한다. 형식은 맞지만 내용상 처리할 수 없는 요청(`…/upstream-unprocessable`)도 이 상태다. | - |
|
|
1963
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
1964
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
1965
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
1966
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
1967
|
+
|
|
1968
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1969
|
+
|
|
1525
1970
|
# **submitNegotiationScores**
|
|
1526
1971
|
> SubmitNegotiationScores201Response submitNegotiationScores(submitNegotiationScoresRequestDto)
|
|
1527
1972
|
|
|
@@ -1661,6 +2106,78 @@ const { status, data } = await apiInstance.updateBid(
|
|
|
1661
2106
|
|
|
1662
2107
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1663
2108
|
|
|
2109
|
+
# **updateWebhookEndpoint**
|
|
2110
|
+
> GetWebhookEndpoint200Response updateWebhookEndpoint(updateWebhookEndpointRequestDto)
|
|
2111
|
+
|
|
2112
|
+
수신 주소·구독 이벤트·상태를 수정합니다. 보낸 필드만 바뀝니다. **호출 시점:** 수신 주소가 바뀌었을 때, 구독 이벤트를 늘리거나 줄일 때, 연속 실패로 자동 중지된 구독을 고친 뒤 되살릴 때(`{\"status\":\"ACTIVE\"}`). **`eventTypes` 는 치환입니다** — 보낸 목록이 곧 새 구독 목록입니다. 하나를 더하려면 기존 목록에 더한 **전체**를 보내세요. **`If-Match` 가 필수입니다.** 먼저 `GET /v2/webhook-endpoints/{endpointId}` 로 현재 `ETag` 를 받아 그대로 실어 보내세요. 이 헤더가 없으면 두 요청이 앞서거니 뒤서거니 하며 먼저 한 수정을 조용히 덮어씁니다. - `428` — 헤더를 빼먹었습니다. 조회 후 `ETag` 를 실어 재시도하세요. - `412` — 그 사이 구독이 바뀌었습니다. 다시 조회해 최신 `ETag` 로 재시도하세요. 아무것도 수정되지 않았습니다. **시크릿은 이 경로로 바뀌지 않습니다** — 재발급은 `rotate-secret` 입니다. **필수 스코프:** `webhooks:write` **멱등성:** `Idempotency-Key` 헤더 필수.
|
|
2113
|
+
|
|
2114
|
+
### Example
|
|
2115
|
+
|
|
2116
|
+
```typescript
|
|
2117
|
+
import {
|
|
2118
|
+
PartnerApiApi,
|
|
2119
|
+
Configuration,
|
|
2120
|
+
UpdateWebhookEndpointRequestDto
|
|
2121
|
+
} from '@cmarket/partner-sdk';
|
|
2122
|
+
|
|
2123
|
+
const configuration = new Configuration();
|
|
2124
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
2125
|
+
|
|
2126
|
+
let endpointId: string; //구독 식별자(등록 응답의 `endpointId`). (default to undefined)
|
|
2127
|
+
let ifMatch: string; //직전 조회 응답의 `ETag` 값. 누락하면 428, 그 사이 구독이 바뀌었으면 412 로 거절되며 아무것도 변경되지 않습니다. (default to undefined)
|
|
2128
|
+
let idempotencyKey: string; //멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. (default to undefined)
|
|
2129
|
+
let updateWebhookEndpointRequestDto: UpdateWebhookEndpointRequestDto; //
|
|
2130
|
+
|
|
2131
|
+
const { status, data } = await apiInstance.updateWebhookEndpoint(
|
|
2132
|
+
endpointId,
|
|
2133
|
+
ifMatch,
|
|
2134
|
+
idempotencyKey,
|
|
2135
|
+
updateWebhookEndpointRequestDto
|
|
2136
|
+
);
|
|
2137
|
+
```
|
|
2138
|
+
|
|
2139
|
+
### Parameters
|
|
2140
|
+
|
|
2141
|
+
|Name | Type | Description | Notes|
|
|
2142
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2143
|
+
| **updateWebhookEndpointRequestDto** | **UpdateWebhookEndpointRequestDto**| | |
|
|
2144
|
+
| **endpointId** | [**string**] | 구독 식별자(등록 응답의 `endpointId`). | defaults to undefined|
|
|
2145
|
+
| **ifMatch** | [**string**] | 직전 조회 응답의 `ETag` 값. 누락하면 428, 그 사이 구독이 바뀌었으면 412 로 거절되며 아무것도 변경되지 않습니다. | defaults to undefined|
|
|
2146
|
+
| **idempotencyKey** | [**string**] | 멱등성 키(1~255자, `[A-Za-z0-9_-]`). **재시도할 때 처음과 같은 키를 다시 보내야** 중복 생성이 막힙니다 — 타임아웃·네트워크 오류로 다시 부르면서 새 키를 만들면 별개 요청으로 처리됩니다. 그래서 키는 UUID v4 를 만들어 **연동 시스템 원장에 저장**하거나, 요청 내용에서 결정적으로 파생(예: `bid-create-{구매번호}`)해 재시도가 같은 값을 재현하도록 하세요. 같은 키 + 같은 body 는 24시간 동안 캐시된 응답을 그대로 돌려줍니다. | defaults to undefined|
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
### Return type
|
|
2150
|
+
|
|
2151
|
+
**GetWebhookEndpoint200Response**
|
|
2152
|
+
|
|
2153
|
+
### Authorization
|
|
2154
|
+
|
|
2155
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
2156
|
+
|
|
2157
|
+
### HTTP request headers
|
|
2158
|
+
|
|
2159
|
+
- **Content-Type**: application/json
|
|
2160
|
+
- **Accept**: application/json, application/problem+json
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
### HTTP response details
|
|
2164
|
+
| Status code | Description | Response headers |
|
|
2165
|
+
|-------------|-------------|------------------|
|
|
2166
|
+
|**200** | 수정된 웹훅 구독. | - |
|
|
2167
|
+
|**400** | 입력 검증 실패(`type: …/validation-failed`), Idempotency-Key 헤더 누락/형식 오류(`…/idempotency-key-required`, `…/idempotency-key-invalid`), 또는 요청 내용이 유효하지 않음(`…/upstream-invalid-input`). | - |
|
|
2168
|
+
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
2169
|
+
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
2170
|
+
|**409** | 원 요청이 아직 처리 중인 상태에서 같은 Idempotency-Key 재전송(`type: …/idempotency-key-conflict` — 잠시 뒤 같은 키로 재시도하면 결과를 받는다) 또는 현재 상태와 충돌하는 요청(`…/upstream-conflict`). | - |
|
|
2171
|
+
|**412** | `If-Match` 지문이 현재 리소스와 다릅니다(`type: …/precondition-failed`). 그 사이 다른 요청이 리소스를 바꿨습니다 — 다시 조회해 최신 ETag 로 재시도하세요. | - |
|
|
2172
|
+
|**422** | 동일 Idempotency-Key 를 **다른 body** 로 재전송(`type: …/idempotency-key-reused`). 재시도해도 동일 실패 — 새 키를 쓰거나 body 를 원래대로 되돌려야 한다. 형식은 맞지만 내용상 처리할 수 없는 요청(`…/upstream-unprocessable`)도 이 상태다. | - |
|
|
2173
|
+
|**428** | `If-Match` 헤더가 없습니다(`type: …/if-match-required`). 잃어버린 갱신을 막기 위해 필수입니다. | - |
|
|
2174
|
+
|**429** | rate limit 초과(`type: …/too-many-requests`) — 전역 60/min per client_id. 대기 시간은 `Retry-After`(초)가 우선하고, 잔여 쿼터·정책은 표준 필드 `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)로 나갑니다. 관용 헤더 `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` 도 함께 실리지만 표준이 아니므로 새 연동은 표준 필드를 읽으세요. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> * RateLimit - 현재 창의 잔여 쿼터. 예: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - 적용 중인 쿼터 정책. 예: `\"default\";q=60;w=60`. <br> |
|
|
2175
|
+
|**500** | 서버 내부 오류(`type: …/internal-server-error`). `retryable: true`. | - |
|
|
2176
|
+
|**502** | 요청을 처리하지 못했습니다(`type: …/upstream-rejected`). `retryable: true`. | - |
|
|
2177
|
+
|**503** | 일시적으로 처리할 수 없습니다(`type: …/service-unavailable`). `Retry-After` 헤더 참조. `retryable: true`. | * Retry-After - 재시도까지 대기할 초. <br> |
|
|
2178
|
+
|
|
2179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2180
|
+
|
|
1664
2181
|
# **uploadFile**
|
|
1665
2182
|
> UploadFile201Response uploadFile(uploadFileRequestDto)
|
|
1666
2183
|
|