@cmarket/partner-sdk 38.2.0 → 38.3.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 +13 -4
- package/api/embed-api.ts +1 -1
- package/api/oauth-api.ts +1 -1
- package/api/partner-api-api.ts +155 -78
- package/api/products-api.ts +15 -8
- package/api/webhooks-api.ts +690 -0
- package/api/well-known-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/embed-api.d.ts +1 -1
- package/dist/api/embed-api.js +1 -1
- package/dist/api/oauth-api.d.ts +1 -1
- package/dist/api/oauth-api.js +1 -1
- package/dist/api/partner-api-api.d.ts +89 -45
- package/dist/api/partner-api-api.js +155 -78
- package/dist/api/products-api.d.ts +9 -5
- package/dist/api/products-api.js +15 -8
- package/dist/api/webhooks-api.d.ts +328 -0
- package/dist/api/webhooks-api.js +675 -0
- package/dist/api/well-known-api.d.ts +1 -1
- package/dist/api/well-known-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/embed-api.d.ts +1 -1
- package/dist/esm/api/embed-api.js +1 -1
- package/dist/esm/api/oauth-api.d.ts +1 -1
- package/dist/esm/api/oauth-api.js +1 -1
- package/dist/esm/api/partner-api-api.d.ts +89 -45
- package/dist/esm/api/partner-api-api.js +155 -78
- package/dist/esm/api/products-api.d.ts +9 -5
- package/dist/esm/api/products-api.js +15 -8
- package/dist/esm/api/webhooks-api.d.ts +328 -0
- package/dist/esm/api/webhooks-api.js +668 -0
- package/dist/esm/api/well-known-api.d.ts +1 -1
- package/dist/esm/api/well-known-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/esm/models/acceptance-result-response-dto.js +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.js +1 -1
- package/dist/esm/models/api-catalog-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-dto.js +1 -1
- package/dist/esm/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-entry-dto.js +1 -1
- package/dist/esm/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-link-dto.js +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.js +1 -1
- package/dist/esm/models/award-method-public.d.ts +1 -1
- package/dist/esm/models/award-method-public.js +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.js +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/esm/models/bid-acceptance-dto.js +1 -1
- package/dist/esm/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/esm/models/bid-attachment-input-dto.js +1 -1
- package/dist/esm/models/bid-bond-dto.d.ts +1 -1
- package/dist/esm/models/bid-bond-dto.js +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.js +1 -1
- package/dist/esm/models/bid-contact-dto.d.ts +1 -1
- package/dist/esm/models/bid-contact-dto.js +1 -1
- package/dist/esm/models/bid-contacts-dto.d.ts +1 -1
- package/dist/esm/models/bid-contacts-dto.js +1 -1
- package/dist/esm/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-contract-document-dto.js +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.js +1 -1
- package/dist/esm/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-detail-response-dto.js +1 -1
- package/dist/esm/models/bid-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-document-dto.js +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-item-dto.js +1 -1
- package/dist/esm/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/esm/models/bid-lifecycle-dto.js +1 -1
- package/dist/esm/models/bid-manager-dto.d.ts +1 -1
- package/dist/esm/models/bid-manager-dto.js +1 -1
- package/dist/esm/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-payment-terms-dto.js +1 -1
- package/dist/esm/models/bid-product-dto.d.ts +1 -1
- package/dist/esm/models/bid-product-dto.js +1 -1
- package/dist/esm/models/bid-public-status.d.ts +1 -1
- package/dist/esm/models/bid-public-status.js +1 -1
- package/dist/esm/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-registered-response-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-dto.js +1 -1
- package/dist/esm/models/bid-results-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-results-response-dto.js +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.js +1 -1
- package/dist/esm/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-response-dto.js +1 -1
- package/dist/esm/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-statement-response-dto.js +1 -1
- package/dist/esm/models/bid-summary-dto.d.ts +1 -1
- package/dist/esm/models/bid-summary-dto.js +1 -1
- package/dist/esm/models/bid-type-public.d.ts +1 -1
- package/dist/esm/models/bid-type-public.js +1 -1
- package/dist/esm/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-updated-response-dto.js +1 -1
- package/dist/esm/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/cancel-bid-request-dto.js +1 -1
- package/dist/esm/models/cancel-bid200-response.d.ts +1 -1
- package/dist/esm/models/cancel-bid200-response.js +1 -1
- package/dist/esm/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/esm/models/card-payment-request-response-dto.js +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.js +1 -1
- package/dist/esm/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/esm/models/complete-acceptance200-response.js +1 -1
- package/dist/esm/models/complete-invoice200-response.d.ts +1 -1
- package/dist/esm/models/complete-invoice200-response.js +1 -1
- package/dist/esm/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-upload-request-dto.js +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/esm/models/create-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/create-bid-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-dto.js +1 -1
- package/dist/esm/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment200-response.d.ts +1 -1
- package/dist/esm/models/create-card-payment200-response.js +1 -1
- package/dist/esm/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/esm/models/create-embed-launch201-response.js +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/esm/models/create-file-upload-url201-response.js +1 -1
- package/dist/esm/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/esm/models/create-upload-url-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/esm/models/delivery-date-type-public.d.ts +1 -1
- package/dist/esm/models/delivery-date-type-public.js +1 -1
- package/dist/esm/models/delivery-method-public.d.ts +1 -1
- package/dist/esm/models/delivery-method-public.js +1 -1
- package/dist/esm/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-request-dto.js +1 -1
- package/dist/esm/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-response-dto.js +1 -1
- package/dist/esm/models/excellent-procurement-public.d.ts +1 -1
- package/dist/esm/models/excellent-procurement-public.js +1 -1
- package/dist/esm/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-document-item-dto.js +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/external-contract-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-item-dto.js +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.js +1 -1
- package/dist/esm/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/esm/models/external-document-inputs-dto.js +1 -1
- package/dist/esm/models/file-meta-response-dto.d.ts +1 -1
- package/dist/esm/models/file-meta-response-dto.js +1 -1
- package/dist/esm/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/esm/models/file-uploaded-response-dto.js +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.js +1 -1
- package/dist/esm/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-settlement200-response.js +1 -1
- package/dist/esm/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-statement200-response.js +1 -1
- package/dist/esm/models/get-bid200-response.d.ts +1 -1
- package/dist/esm/models/get-bid200-response.js +1 -1
- package/dist/esm/models/get-file-meta200-response.d.ts +1 -1
- package/dist/esm/models/get-file-meta200-response.js +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/esm/models/green-product-public.d.ts +1 -1
- package/dist/esm/models/green-product-public.js +1 -1
- package/dist/esm/models/health-controller-check200-response.d.ts +1 -1
- package/dist/esm/models/health-controller-check200-response.js +1 -1
- package/dist/esm/models/health-response-dto.d.ts +1 -1
- package/dist/esm/models/health-response-dto.js +1 -1
- package/dist/esm/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/esm/models/hierarchical-region-dto.js +1 -1
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/esm/models/introspect-request-dto.d.ts +1 -1
- package/dist/esm/models/introspect-request-dto.js +1 -1
- package/dist/esm/models/introspection-response-dto.d.ts +1 -1
- package/dist/esm/models/introspection-response-dto.js +1 -1
- package/dist/esm/models/invalid-param-dto.d.ts +1 -1
- package/dist/esm/models/invalid-param-dto.js +1 -1
- package/dist/esm/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-completed-response-dto.js +1 -1
- package/dist/esm/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-split-response-dto.js +1 -1
- package/dist/esm/models/legal-mandatory-public.d.ts +1 -1
- package/dist/esm/models/legal-mandatory-public.js +1 -1
- package/dist/esm/models/list-bid-results200-response.d.ts +1 -1
- package/dist/esm/models/list-bid-results200-response.js +1 -1
- package/dist/esm/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/esm/models/list-bids200-response-meta.js +1 -1
- package/dist/esm/models/list-bids200-response.d.ts +1 -1
- package/dist/esm/models/list-bids200-response.js +1 -1
- package/dist/esm/models/list-products200-response.d.ts +1 -1
- package/dist/esm/models/list-products200-response.js +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/esm/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed201-response.js +1 -1
- package/dist/esm/models/negotiation-score-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-score-dto.js +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/esm/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/esm/models/oauth-error-response-dto.js +1 -1
- package/dist/esm/models/on-bid-award-reverted-request.d.ts +16 -0
- package/dist/esm/models/on-bid-award-reverted-request.js +14 -0
- package/dist/esm/models/on-bid-awarded-request.d.ts +16 -0
- package/dist/esm/models/on-bid-awarded-request.js +14 -0
- package/dist/esm/models/on-bid-canceled-request.d.ts +16 -0
- package/dist/esm/models/on-bid-canceled-request.js +14 -0
- package/dist/esm/models/on-bid-closed-request.d.ts +16 -0
- package/dist/esm/models/on-bid-closed-request.js +14 -0
- package/dist/esm/models/on-bid-failed-request.d.ts +16 -0
- package/dist/esm/models/on-bid-failed-request.js +14 -0
- package/dist/esm/models/on-ping-request.d.ts +16 -0
- package/dist/esm/models/on-ping-request.js +14 -0
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-delivery-status.js +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/esm/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/esm/models/partner-webhook-event-type.js +1 -1
- package/dist/esm/models/payment-method-public.d.ts +1 -1
- package/dist/esm/models/payment-method-public.js +1 -1
- package/dist/esm/models/preconditions-dto.d.ts +1 -1
- package/dist/esm/models/preconditions-dto.js +1 -1
- package/dist/esm/models/problem-details-dto.d.ts +1 -1
- package/dist/esm/models/problem-details-dto.js +1 -1
- package/dist/esm/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/esm/models/product-receipt-response-dto.js +1 -1
- package/dist/esm/models/product-response-dto.d.ts +1 -1
- package/dist/esm/models/product-response-dto.js +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.js +1 -1
- package/dist/esm/models/register-award-request-dto.d.ts +1 -1
- package/dist/esm/models/register-award-request-dto.js +1 -1
- package/dist/esm/models/register-award201-response.d.ts +1 -1
- package/dist/esm/models/register-award201-response.js +1 -1
- package/dist/esm/models/register-bid201-response.d.ts +1 -1
- package/dist/esm/models/register-bid201-response.js +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/esm/models/request-invoice-split200-response.js +1 -1
- package/dist/esm/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-input-dto.js +1 -1
- package/dist/esm/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-row-dto.js +1 -1
- package/dist/esm/models/revert-award-request-dto.d.ts +1 -1
- package/dist/esm/models/revert-award-request-dto.js +1 -1
- package/dist/esm/models/revert-award200-response.d.ts +1 -1
- package/dist/esm/models/revert-award200-response.js +1 -1
- package/dist/esm/models/revoke-request-dto.d.ts +1 -1
- package/dist/esm/models/revoke-request-dto.js +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.js +1 -1
- package/dist/esm/models/statement-document-dto.d.ts +1 -1
- package/dist/esm/models/statement-document-dto.js +1 -1
- package/dist/esm/models/statement-product-dto.d.ts +1 -1
- package/dist/esm/models/statement-product-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/esm/models/supplier-tax-type.d.ts +1 -1
- package/dist/esm/models/supplier-tax-type.js +1 -1
- package/dist/esm/models/token-request-dto.d.ts +1 -1
- package/dist/esm/models/token-request-dto.js +1 -1
- package/dist/esm/models/token-response-dto.d.ts +1 -1
- package/dist/esm/models/token-response-dto.js +1 -1
- package/dist/esm/models/update-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/update-bid-request-dto.js +1 -1
- package/dist/esm/models/update-bid200-response.d.ts +1 -1
- package/dist/esm/models/update-bid200-response.js +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/upload-file-request-dto.d.ts +1 -1
- package/dist/esm/models/upload-file-request-dto.js +1 -1
- package/dist/esm/models/upload-file201-response.d.ts +1 -1
- package/dist/esm/models/upload-file201-response.js +1 -1
- package/dist/esm/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/esm/models/upload-url-created-response-dto.js +1 -1
- package/dist/esm/models/webhook-bid-event-data.d.ts +33 -0
- package/dist/esm/models/webhook-bid-event-data.js +14 -0
- package/dist/esm/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/esm/models/webhook-delivery-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/esm/models/webhook-event-envelope.d.ts +34 -0
- package/dist/esm/models/webhook-event-envelope.js +14 -0
- package/dist/esm/models/webhook-ping-event-data.d.ts +20 -0
- package/dist/esm/models/webhook-ping-event-data.js +14 -0
- package/dist/esm/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/esm/models/webhook-test-result-dto.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/models/acceptance-result-response-dto.js +1 -1
- package/dist/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/models/acknowledge-products-request-dto.js +1 -1
- package/dist/models/api-catalog-dto.d.ts +1 -1
- package/dist/models/api-catalog-dto.js +1 -1
- package/dist/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/models/api-catalog-entry-dto.js +1 -1
- package/dist/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/models/api-catalog-link-dto.js +1 -1
- package/dist/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/models/authorization-server-metadata-dto.js +1 -1
- package/dist/models/award-method-public.d.ts +1 -1
- package/dist/models/award-method-public.js +1 -1
- package/dist/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/models/award-registered-v2-response-dto.js +1 -1
- package/dist/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/models/bid-acceptance-dto.js +1 -1
- package/dist/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/models/bid-attachment-input-dto.js +1 -1
- package/dist/models/bid-bond-dto.d.ts +1 -1
- package/dist/models/bid-bond-dto.js +1 -1
- package/dist/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/models/bid-cancelled-response-dto.js +1 -1
- package/dist/models/bid-contact-dto.d.ts +1 -1
- package/dist/models/bid-contact-dto.js +1 -1
- package/dist/models/bid-contacts-dto.d.ts +1 -1
- package/dist/models/bid-contacts-dto.js +1 -1
- package/dist/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/models/bid-contract-document-dto.js +1 -1
- package/dist/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/models/bid-delivery-terms-dto.js +1 -1
- package/dist/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/models/bid-detail-response-dto.js +1 -1
- package/dist/models/bid-document-dto.d.ts +1 -1
- package/dist/models/bid-document-dto.js +1 -1
- package/dist/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/models/bid-item-dto.d.ts +1 -1
- package/dist/models/bid-item-dto.js +1 -1
- package/dist/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/models/bid-lifecycle-dto.js +1 -1
- package/dist/models/bid-manager-dto.d.ts +1 -1
- package/dist/models/bid-manager-dto.js +1 -1
- package/dist/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/models/bid-payment-terms-dto.js +1 -1
- package/dist/models/bid-product-dto.d.ts +1 -1
- package/dist/models/bid-product-dto.js +1 -1
- package/dist/models/bid-public-status.d.ts +1 -1
- package/dist/models/bid-public-status.js +1 -1
- package/dist/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/models/bid-registered-response-dto.js +1 -1
- package/dist/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-dto.js +1 -1
- package/dist/models/bid-results-response-dto.d.ts +1 -1
- package/dist/models/bid-results-response-dto.js +1 -1
- package/dist/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/models/bid-settlement-participant-dto.js +1 -1
- package/dist/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/models/bid-settlement-response-dto.js +1 -1
- package/dist/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/models/bid-statement-response-dto.js +1 -1
- package/dist/models/bid-summary-dto.d.ts +1 -1
- package/dist/models/bid-summary-dto.js +1 -1
- package/dist/models/bid-type-public.d.ts +1 -1
- package/dist/models/bid-type-public.js +1 -1
- package/dist/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/models/bid-updated-response-dto.js +1 -1
- package/dist/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/models/cancel-bid-request-dto.js +1 -1
- package/dist/models/cancel-bid200-response.d.ts +1 -1
- package/dist/models/cancel-bid200-response.js +1 -1
- package/dist/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/models/card-payment-request-response-dto.js +1 -1
- package/dist/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/models/complete-acceptance-request-dto.js +1 -1
- package/dist/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/models/complete-acceptance200-response.js +1 -1
- package/dist/models/complete-invoice200-response.d.ts +1 -1
- package/dist/models/complete-invoice200-response.js +1 -1
- package/dist/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/models/complete-upload-request-dto.js +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/models/create-bid-request-dto.d.ts +1 -1
- package/dist/models/create-bid-request-dto.js +1 -1
- package/dist/models/create-card-payment-dto.d.ts +1 -1
- package/dist/models/create-card-payment-dto.js +1 -1
- package/dist/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/models/create-card-payment-request-dto.js +1 -1
- package/dist/models/create-card-payment200-response.d.ts +1 -1
- package/dist/models/create-card-payment200-response.js +1 -1
- package/dist/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/models/create-embed-launch201-response.js +1 -1
- package/dist/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/models/create-file-upload-url201-response.js +1 -1
- package/dist/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/models/create-upload-url-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/models/delivery-date-type-public.d.ts +1 -1
- package/dist/models/delivery-date-type-public.js +1 -1
- package/dist/models/delivery-method-public.d.ts +1 -1
- package/dist/models/delivery-method-public.js +1 -1
- package/dist/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/models/embed-launch-request-dto.js +1 -1
- package/dist/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/models/embed-launch-response-dto.js +1 -1
- package/dist/models/excellent-procurement-public.d.ts +1 -1
- package/dist/models/excellent-procurement-public.js +1 -1
- package/dist/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/models/external-contract-document-item-dto.js +1 -1
- package/dist/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/external-contract-documents-response-dto.js +1 -1
- package/dist/models/external-contract-item-dto.d.ts +1 -1
- package/dist/models/external-contract-item-dto.js +1 -1
- package/dist/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/models/external-contract-snapshot-dto.js +1 -1
- package/dist/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/models/external-document-inputs-dto.js +1 -1
- package/dist/models/file-meta-response-dto.d.ts +1 -1
- package/dist/models/file-meta-response-dto.js +1 -1
- package/dist/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/models/file-uploaded-response-dto.js +1 -1
- package/dist/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/models/generated-external-contract-document-dto.js +1 -1
- package/dist/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/models/get-bid-settlement200-response.js +1 -1
- package/dist/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/models/get-bid-statement200-response.js +1 -1
- package/dist/models/get-bid200-response.d.ts +1 -1
- package/dist/models/get-bid200-response.js +1 -1
- package/dist/models/get-file-meta200-response.d.ts +1 -1
- package/dist/models/get-file-meta200-response.js +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/models/green-product-public.d.ts +1 -1
- package/dist/models/green-product-public.js +1 -1
- package/dist/models/health-controller-check200-response.d.ts +1 -1
- package/dist/models/health-controller-check200-response.js +1 -1
- package/dist/models/health-response-dto.d.ts +1 -1
- package/dist/models/health-response-dto.js +1 -1
- package/dist/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/models/hierarchical-region-dto.js +1 -1
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/dist/models/introspect-request-dto.d.ts +1 -1
- package/dist/models/introspect-request-dto.js +1 -1
- package/dist/models/introspection-response-dto.d.ts +1 -1
- package/dist/models/introspection-response-dto.js +1 -1
- package/dist/models/invalid-param-dto.d.ts +1 -1
- package/dist/models/invalid-param-dto.js +1 -1
- package/dist/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/models/invoice-completed-response-dto.js +1 -1
- package/dist/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/models/invoice-split-response-dto.js +1 -1
- package/dist/models/legal-mandatory-public.d.ts +1 -1
- package/dist/models/legal-mandatory-public.js +1 -1
- package/dist/models/list-bid-results200-response.d.ts +1 -1
- package/dist/models/list-bid-results200-response.js +1 -1
- package/dist/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/models/list-bids200-response-meta.js +1 -1
- package/dist/models/list-bids200-response.d.ts +1 -1
- package/dist/models/list-bids200-response.js +1 -1
- package/dist/models/list-products200-response.d.ts +1 -1
- package/dist/models/list-products200-response.js +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/models/mark-bid-failed201-response.js +1 -1
- package/dist/models/negotiation-score-dto.d.ts +1 -1
- package/dist/models/negotiation-score-dto.js +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/models/oauth-error-response-dto.js +1 -1
- package/dist/models/on-bid-award-reverted-request.d.ts +16 -0
- package/dist/models/on-bid-award-reverted-request.js +15 -0
- package/dist/models/on-bid-awarded-request.d.ts +16 -0
- package/dist/models/on-bid-awarded-request.js +15 -0
- package/dist/models/on-bid-canceled-request.d.ts +16 -0
- package/dist/models/on-bid-canceled-request.js +15 -0
- package/dist/models/on-bid-closed-request.d.ts +16 -0
- package/dist/models/on-bid-closed-request.js +15 -0
- package/dist/models/on-bid-failed-request.d.ts +16 -0
- package/dist/models/on-bid-failed-request.js +15 -0
- package/dist/models/on-ping-request.d.ts +16 -0
- package/dist/models/on-ping-request.js +15 -0
- package/dist/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/models/partner-webhook-delivery-status.js +1 -1
- package/dist/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/models/partner-webhook-event-type.js +1 -1
- package/dist/models/payment-method-public.d.ts +1 -1
- package/dist/models/payment-method-public.js +1 -1
- package/dist/models/preconditions-dto.d.ts +1 -1
- package/dist/models/preconditions-dto.js +1 -1
- package/dist/models/problem-details-dto.d.ts +1 -1
- package/dist/models/problem-details-dto.js +1 -1
- package/dist/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/models/product-receipt-response-dto.js +1 -1
- package/dist/models/product-response-dto.d.ts +1 -1
- package/dist/models/product-response-dto.js +1 -1
- package/dist/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/models/protected-resource-metadata-dto.js +1 -1
- package/dist/models/register-award-request-dto.d.ts +1 -1
- package/dist/models/register-award-request-dto.js +1 -1
- package/dist/models/register-award201-response.d.ts +1 -1
- package/dist/models/register-award201-response.js +1 -1
- package/dist/models/register-bid201-response.d.ts +1 -1
- package/dist/models/register-bid201-response.js +1 -1
- package/dist/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/models/register-semo-contract-request-dto.js +1 -1
- package/dist/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/models/request-invoice-split-request-dto.js +1 -1
- package/dist/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/models/request-invoice-split200-response.js +1 -1
- package/dist/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/models/retiree-roster-input-dto.js +1 -1
- package/dist/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/models/retiree-roster-row-dto.js +1 -1
- package/dist/models/revert-award-request-dto.d.ts +1 -1
- package/dist/models/revert-award-request-dto.js +1 -1
- package/dist/models/revert-award200-response.d.ts +1 -1
- package/dist/models/revert-award200-response.js +1 -1
- package/dist/models/revoke-request-dto.d.ts +1 -1
- package/dist/models/revoke-request-dto.js +1 -1
- package/dist/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/models/send-webhook-test-event200-response.js +1 -1
- package/dist/models/statement-document-dto.d.ts +1 -1
- package/dist/models/statement-document-dto.js +1 -1
- package/dist/models/statement-product-dto.d.ts +1 -1
- package/dist/models/statement-product-dto.js +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/models/supplier-tax-type.d.ts +1 -1
- package/dist/models/supplier-tax-type.js +1 -1
- package/dist/models/token-request-dto.d.ts +1 -1
- package/dist/models/token-request-dto.js +1 -1
- package/dist/models/token-response-dto.d.ts +1 -1
- package/dist/models/token-response-dto.js +1 -1
- package/dist/models/update-bid-request-dto.d.ts +1 -1
- package/dist/models/update-bid-request-dto.js +1 -1
- package/dist/models/update-bid200-response.d.ts +1 -1
- package/dist/models/update-bid200-response.js +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/upload-file-request-dto.d.ts +1 -1
- package/dist/models/upload-file-request-dto.js +1 -1
- package/dist/models/upload-file201-response.d.ts +1 -1
- package/dist/models/upload-file201-response.js +1 -1
- package/dist/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/models/upload-url-created-response-dto.js +1 -1
- package/dist/models/webhook-bid-event-data.d.ts +33 -0
- package/dist/models/webhook-bid-event-data.js +15 -0
- package/dist/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/models/webhook-delivery-dto.js +1 -1
- package/dist/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-dto.js +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/models/webhook-event-envelope.d.ts +34 -0
- package/dist/models/webhook-event-envelope.js +15 -0
- package/dist/models/webhook-ping-event-data.d.ts +20 -0
- package/dist/models/webhook-ping-event-data.js +15 -0
- package/dist/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/models/webhook-test-result-dto.js +1 -1
- package/docs/OnBidAwardRevertedRequest.md +26 -0
- package/docs/OnBidAwardedRequest.md +26 -0
- package/docs/OnBidCanceledRequest.md +26 -0
- package/docs/OnBidClosedRequest.md +26 -0
- package/docs/OnBidFailedRequest.md +26 -0
- package/docs/OnPingRequest.md +26 -0
- package/docs/PartnerApiApi.md +65 -13
- package/docs/ProductsApi.md +5 -1
- package/docs/WebhookBidEventData.md +27 -0
- package/docs/WebhookEventEnvelope.md +27 -0
- package/docs/WebhookPingEventData.md +21 -0
- package/docs/WebhooksApi.md +403 -0
- package/index.ts +1 -1
- package/models/acceptance-result-response-dto.ts +1 -1
- package/models/acknowledge-product-receipt200-response.ts +1 -1
- package/models/acknowledge-products-request-dto.ts +1 -1
- package/models/api-catalog-dto.ts +1 -1
- package/models/api-catalog-entry-dto.ts +1 -1
- package/models/api-catalog-link-dto.ts +1 -1
- package/models/authorization-server-metadata-dto.ts +1 -1
- package/models/award-method-public.ts +1 -1
- package/models/award-registered-v2-response-dto.ts +1 -1
- package/models/award-reverted-v2-response-dto.ts +1 -1
- package/models/bid-acceptance-dto.ts +1 -1
- package/models/bid-attachment-input-dto.ts +1 -1
- package/models/bid-bond-dto.ts +1 -1
- package/models/bid-cancelled-response-dto.ts +1 -1
- package/models/bid-contact-dto.ts +1 -1
- package/models/bid-contacts-dto.ts +1 -1
- package/models/bid-contract-document-dto.ts +1 -1
- package/models/bid-delivery-terms-dto.ts +1 -1
- package/models/bid-detail-response-dto.ts +1 -1
- package/models/bid-document-dto.ts +1 -1
- package/models/bid-failed-v2-response-dto.ts +1 -1
- package/models/bid-item-dto.ts +1 -1
- package/models/bid-lifecycle-dto.ts +1 -1
- package/models/bid-manager-dto.ts +1 -1
- package/models/bid-payment-terms-dto.ts +1 -1
- package/models/bid-product-dto.ts +1 -1
- package/models/bid-public-status.ts +1 -1
- package/models/bid-registered-response-dto.ts +1 -1
- package/models/bid-result-participant-attachment-dto.ts +1 -1
- package/models/bid-result-participant-dto.ts +1 -1
- package/models/bid-results-response-dto.ts +1 -1
- package/models/bid-settlement-line-item-dto.ts +1 -1
- package/models/bid-settlement-participant-dto.ts +1 -1
- package/models/bid-settlement-response-dto.ts +1 -1
- package/models/bid-statement-response-dto.ts +1 -1
- package/models/bid-summary-dto.ts +1 -1
- package/models/bid-type-public.ts +1 -1
- package/models/bid-updated-response-dto.ts +1 -1
- package/models/cancel-bid-request-dto.ts +1 -1
- package/models/cancel-bid200-response.ts +1 -1
- package/models/card-payment-request-response-dto.ts +1 -1
- package/models/complete-acceptance-request-dto.ts +1 -1
- package/models/complete-acceptance200-response.ts +1 -1
- package/models/complete-invoice200-response.ts +1 -1
- package/models/complete-upload-request-dto.ts +1 -1
- package/models/contract-restriction-confirm-input-dto.ts +1 -1
- package/models/create-bid-request-dto.ts +1 -1
- package/models/create-card-payment-dto.ts +1 -1
- package/models/create-card-payment-request-dto.ts +1 -1
- package/models/create-card-payment200-response.ts +1 -1
- package/models/create-embed-launch201-response.ts +1 -1
- package/models/create-external-contract-documents-request-dto.ts +1 -1
- package/models/create-external-contract-documents-response-dto.ts +1 -1
- package/models/create-file-upload-url201-response.ts +1 -1
- package/models/create-upload-url-request-dto.ts +1 -1
- package/models/create-webhook-endpoint-request-dto.ts +1 -1
- package/models/create-webhook-endpoint201-response.ts +1 -1
- package/models/delivery-date-type-public.ts +1 -1
- package/models/delivery-method-public.ts +1 -1
- package/models/embed-launch-request-dto.ts +1 -1
- package/models/embed-launch-response-dto.ts +1 -1
- package/models/excellent-procurement-public.ts +1 -1
- package/models/external-contract-document-item-dto.ts +1 -1
- package/models/external-contract-documents-response-dto.ts +1 -1
- package/models/external-contract-item-dto.ts +1 -1
- package/models/external-contract-snapshot-dto.ts +1 -1
- package/models/external-document-inputs-dto.ts +1 -1
- package/models/file-meta-response-dto.ts +1 -1
- package/models/file-uploaded-response-dto.ts +1 -1
- package/models/generated-external-contract-document-dto.ts +1 -1
- package/models/get-bid-settlement200-response.ts +1 -1
- package/models/get-bid-statement200-response.ts +1 -1
- package/models/get-bid200-response.ts +1 -1
- package/models/get-file-meta200-response.ts +1 -1
- package/models/get-supplier-card-payable-v2200-response.ts +1 -1
- package/models/get-webhook-endpoint200-response.ts +1 -1
- package/models/green-product-public.ts +1 -1
- package/models/health-controller-check200-response.ts +1 -1
- package/models/health-response-dto.ts +1 -1
- package/models/hierarchical-region-dto.ts +1 -1
- package/models/index.ts +9 -0
- package/models/introspect-request-dto.ts +1 -1
- package/models/introspection-response-dto.ts +1 -1
- package/models/invalid-param-dto.ts +1 -1
- package/models/invoice-completed-response-dto.ts +1 -1
- package/models/invoice-split-response-dto.ts +1 -1
- package/models/legal-mandatory-public.ts +1 -1
- package/models/list-bid-results200-response.ts +1 -1
- package/models/list-bids200-response-meta.ts +1 -1
- package/models/list-bids200-response.ts +1 -1
- package/models/list-products200-response.ts +1 -1
- package/models/list-webhook-deliveries-response-dto.ts +1 -1
- package/models/list-webhook-deliveries200-response.ts +1 -1
- package/models/list-webhook-endpoints200-response.ts +1 -1
- package/models/mark-bid-failed-request-dto.ts +1 -1
- package/models/mark-bid-failed201-response.ts +1 -1
- package/models/negotiation-score-dto.ts +1 -1
- package/models/negotiation-scored-v2-response-dto.ts +1 -1
- package/models/oauth-error-response-dto.ts +1 -1
- package/models/on-bid-award-reverted-request.ts +28 -0
- package/models/on-bid-awarded-request.ts +28 -0
- package/models/on-bid-canceled-request.ts +28 -0
- package/models/on-bid-closed-request.ts +28 -0
- package/models/on-bid-failed-request.ts +28 -0
- package/models/on-ping-request.ts +28 -0
- package/models/partner-webhook-delivery-status.ts +1 -1
- package/models/partner-webhook-endpoint-status.ts +1 -1
- package/models/partner-webhook-event-type.ts +1 -1
- package/models/payment-method-public.ts +1 -1
- package/models/preconditions-dto.ts +1 -1
- package/models/problem-details-dto.ts +1 -1
- package/models/product-receipt-response-dto.ts +1 -1
- package/models/product-response-dto.ts +1 -1
- package/models/protected-resource-metadata-dto.ts +1 -1
- package/models/register-award-request-dto.ts +1 -1
- package/models/register-award201-response.ts +1 -1
- package/models/register-bid201-response.ts +1 -1
- package/models/register-semo-contract-request-dto.ts +1 -1
- package/models/request-invoice-split-request-dto.ts +1 -1
- package/models/request-invoice-split200-response.ts +1 -1
- package/models/retiree-roster-input-dto.ts +1 -1
- package/models/retiree-roster-row-dto.ts +1 -1
- package/models/revert-award-request-dto.ts +1 -1
- package/models/revert-award200-response.ts +1 -1
- package/models/revoke-request-dto.ts +1 -1
- package/models/semo-contract-registered-response-dto.ts +1 -1
- package/models/semo-contract-taxinvoice-status-response-dto.ts +1 -1
- package/models/send-webhook-test-event200-response.ts +1 -1
- package/models/statement-document-dto.ts +1 -1
- package/models/statement-product-dto.ts +1 -1
- package/models/submit-negotiation-scores-request-dto.ts +1 -1
- package/models/submit-negotiation-scores201-response.ts +1 -1
- package/models/supplier-card-payable-response-dto.ts +1 -1
- package/models/supplier-tax-type.ts +1 -1
- package/models/token-request-dto.ts +1 -1
- package/models/token-response-dto.ts +1 -1
- package/models/update-bid-request-dto.ts +1 -1
- package/models/update-bid200-response.ts +1 -1
- package/models/update-webhook-endpoint-request-dto.ts +1 -1
- package/models/upload-file-request-dto.ts +1 -1
- package/models/upload-file201-response.ts +1 -1
- package/models/upload-url-created-response-dto.ts +1 -1
- package/models/webhook-bid-event-data.ts +43 -0
- package/models/webhook-delivery-dto.ts +1 -1
- package/models/webhook-endpoint-dto.ts +1 -1
- package/models/webhook-endpoint-with-secret-dto.ts +1 -1
- package/models/webhook-event-envelope.ts +38 -0
- package/models/webhook-ping-event-data.ts +26 -0
- package/models/webhook-test-result-dto.ts +1 -1
- package/package.json +1 -1
package/docs/ProductsApi.md
CHANGED
|
@@ -88,9 +88,11 @@ const configuration = new Configuration();
|
|
|
88
88
|
const apiInstance = new ProductsApi(configuration);
|
|
89
89
|
|
|
90
90
|
let limit: number; //한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 `meta.hasMore` 가 `false` 가 될 때까지 반복하세요. (optional) (default to undefined)
|
|
91
|
+
let ifNoneMatch: string; //직전 응답의 `ETag` 값. 내용이 그대로면 본문 없이 `304` 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다. (optional) (default to undefined)
|
|
91
92
|
|
|
92
93
|
const { status, data } = await apiInstance.listProducts(
|
|
93
|
-
limit
|
|
94
|
+
limit,
|
|
95
|
+
ifNoneMatch
|
|
94
96
|
);
|
|
95
97
|
```
|
|
96
98
|
|
|
@@ -99,6 +101,7 @@ const { status, data } = await apiInstance.listProducts(
|
|
|
99
101
|
|Name | Type | Description | Notes|
|
|
100
102
|
|------------- | ------------- | ------------- | -------------|
|
|
101
103
|
| **limit** | [**number**] | 한 번에 받을 최대 물품 수(1~1000). 미지정이면 미전송 물품을 **전부** 받습니다(종전 동작). 카탈로그가 커서 응답이 부담스러우면 이 값을 주고 `meta.hasMore` 가 `false` 가 될 때까지 반복하세요. | (optional) defaults to undefined|
|
|
104
|
+
| **ifNoneMatch** | [**string**] | 직전 응답의 `ETag` 값. 내용이 그대로면 본문 없이 `304` 로 끝납니다 — 폴링에서 전송량과 파싱 비용이 사라집니다. | (optional) defaults to undefined|
|
|
102
105
|
|
|
103
106
|
|
|
104
107
|
### Return type
|
|
@@ -119,6 +122,7 @@ const { status, data } = await apiInstance.listProducts(
|
|
|
119
122
|
| Status code | Description | Response headers |
|
|
120
123
|
|-------------|-------------|------------------|
|
|
121
124
|
|**200** | 미전송 물품 목록. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
125
|
+
|**304** | `If-None-Match` 지문이 현재 리소스와 같습니다 — 내용이 바뀌지 않았습니다. **본문이 없습니다.** 직전에 받은 값을 그대로 쓰세요. | * ETag - 리소스 지문(weak). 다음 요청의 `If-None-Match` 헤더로 되보내면 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. <br> |
|
|
122
126
|
|**400** | 쿼리/본문 입력 검증 실패(`type: …/validation-failed`) — 상한 초과(`bidRefs` 101건 등), 값 형식 위반, 알 수 없는 `cursor` 등. | - |
|
|
123
127
|
|**401** | Bearer 토큰 없음(`type: …/missing-bearer-token`) 또는 만료/위변조/폐기(`…/invalid-token`). | - |
|
|
124
128
|
|**403** | 키 미바인딩(`type: …/unbound-partner-key`), 클라이언트 IP 차단(`…/ip-not-allowed`), 스코프 부족(`…/insufficient-scope`), buyerId 가 키의 대행 범위 밖(`…/buyer-scope-mismatch` — 샌드박스 키의 범위 위반도 이 slug), 또는 요청 권한 없음(`…/upstream-forbidden`). | - |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# WebhookBidEventData
|
|
2
|
+
|
|
3
|
+
공고 상태 전이 이벤트의 본문. 상세는 `GET /v2/bids/{bidId}` 가 SSOT 입니다.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**bidId** | **string** | 공고 식별자. | [default to undefined]
|
|
10
|
+
**status** | [**BidPublicStatus**](BidPublicStatus.md) | 전이 후 공고 상태(공개값). | [default to undefined]
|
|
11
|
+
**previousStatus** | [**BidPublicStatus**](BidPublicStatus.md) | 전이 전 공고 상태(공개값). 직전 상태를 특정할 수 없으면 null. | [optional] [default to undefined]
|
|
12
|
+
**occurredAt** | **string** | 전이 시각(UTC ISO-8601). | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { WebhookBidEventData } from '@cmarket/partner-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: WebhookBidEventData = {
|
|
20
|
+
bidId,
|
|
21
|
+
status,
|
|
22
|
+
previousStatus,
|
|
23
|
+
occurredAt,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# WebhookEventEnvelope
|
|
2
|
+
|
|
3
|
+
모든 웹훅 본문의 공통 봉투. 필드 순서가 곧 서명 대상 바이트 순서입니다.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | 이벤트 식별자. `webhook-id` 헤더와 같은 값입니다. | [default to undefined]
|
|
10
|
+
**type** | **string** | 이벤트 타입. | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | 이벤트 발생 시각(UTC ISO-8601). | [default to undefined]
|
|
12
|
+
**data** | **{ [key: string]: any; }** | 이벤트별 본문. 아래 이벤트 항목의 스키마를 보세요. | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { WebhookEventEnvelope } from '@cmarket/partner-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: WebhookEventEnvelope = {
|
|
20
|
+
id,
|
|
21
|
+
type,
|
|
22
|
+
createdAt,
|
|
23
|
+
data,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# WebhookPingEventData
|
|
2
|
+
|
|
3
|
+
연결 확인 발송의 본문.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**endpointId** | **string** | 확인을 요청한 구독 식별자. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { WebhookPingEventData } from '@cmarket/partner-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: WebhookPingEventData = {
|
|
17
|
+
endpointId,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,403 @@
|
|
|
1
|
+
# WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://partner-api.c-market.net*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**onBidAwardReverted**](#onbidawardreverted) | **POST** /bid.award_reverted | 운영자가 낙찰을 되돌렸습니다 — 이미 받은 `bid.awarded` 를 무효로 취급하세요.|
|
|
8
|
+
|[**onBidAwarded**](#onbidawarded) | **POST** /bid.awarded | 낙찰 확정.|
|
|
9
|
+
|[**onBidCanceled**](#onbidcanceled) | **POST** /bid.canceled | 발주기관 또는 운영자의 공고 취소.|
|
|
10
|
+
|[**onBidClosed**](#onbidclosed) | **POST** /bid.closed | 공고 마감 — 응찰 접수가 끝났습니다(낙찰자는 아직 정해지지 않았습니다).|
|
|
11
|
+
|[**onBidFailed**](#onbidfailed) | **POST** /bid.failed | 유찰 확정.|
|
|
12
|
+
|[**onPing**](#onping) | **POST** /ping | 연결 확인 발송. **구독할 수 없습니다** — `POST /v2/webhook-endpoints/{endpointId}/test` 가 즉시 1회 보낼 때만 옵니다.|
|
|
13
|
+
|
|
14
|
+
# **onBidAwardReverted**
|
|
15
|
+
> onBidAwardReverted(onBidAwardRevertedRequest)
|
|
16
|
+
|
|
17
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
WebhooksApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
OnBidAwardRevertedRequest
|
|
26
|
+
} from '@cmarket/partner-sdk';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
30
|
+
|
|
31
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
32
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
33
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
34
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
35
|
+
let onBidAwardRevertedRequest: OnBidAwardRevertedRequest; //
|
|
36
|
+
|
|
37
|
+
const { status, data } = await apiInstance.onBidAwardReverted(
|
|
38
|
+
webhookId,
|
|
39
|
+
webhookEventType,
|
|
40
|
+
webhookTimestamp,
|
|
41
|
+
webhookSignature,
|
|
42
|
+
onBidAwardRevertedRequest
|
|
43
|
+
);
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
|Name | Type | Description | Notes|
|
|
49
|
+
|------------- | ------------- | ------------- | -------------|
|
|
50
|
+
| **onBidAwardRevertedRequest** | **OnBidAwardRevertedRequest**| | |
|
|
51
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
52
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
53
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
54
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
void (empty response body)
|
|
60
|
+
|
|
61
|
+
### Authorization
|
|
62
|
+
|
|
63
|
+
No authorization required
|
|
64
|
+
|
|
65
|
+
### HTTP request headers
|
|
66
|
+
|
|
67
|
+
- **Content-Type**: application/json
|
|
68
|
+
- **Accept**: Not defined
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### HTTP response details
|
|
72
|
+
| Status code | Description | Response headers |
|
|
73
|
+
|-------------|-------------|------------------|
|
|
74
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
75
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
76
|
+
|
|
77
|
+
[[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)
|
|
78
|
+
|
|
79
|
+
# **onBidAwarded**
|
|
80
|
+
> onBidAwarded(onBidAwardedRequest)
|
|
81
|
+
|
|
82
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import {
|
|
88
|
+
WebhooksApi,
|
|
89
|
+
Configuration,
|
|
90
|
+
OnBidAwardedRequest
|
|
91
|
+
} from '@cmarket/partner-sdk';
|
|
92
|
+
|
|
93
|
+
const configuration = new Configuration();
|
|
94
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
95
|
+
|
|
96
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
97
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
98
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
99
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
100
|
+
let onBidAwardedRequest: OnBidAwardedRequest; //
|
|
101
|
+
|
|
102
|
+
const { status, data } = await apiInstance.onBidAwarded(
|
|
103
|
+
webhookId,
|
|
104
|
+
webhookEventType,
|
|
105
|
+
webhookTimestamp,
|
|
106
|
+
webhookSignature,
|
|
107
|
+
onBidAwardedRequest
|
|
108
|
+
);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
|Name | Type | Description | Notes|
|
|
114
|
+
|------------- | ------------- | ------------- | -------------|
|
|
115
|
+
| **onBidAwardedRequest** | **OnBidAwardedRequest**| | |
|
|
116
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
117
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
118
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
119
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Return type
|
|
123
|
+
|
|
124
|
+
void (empty response body)
|
|
125
|
+
|
|
126
|
+
### Authorization
|
|
127
|
+
|
|
128
|
+
No authorization required
|
|
129
|
+
|
|
130
|
+
### HTTP request headers
|
|
131
|
+
|
|
132
|
+
- **Content-Type**: application/json
|
|
133
|
+
- **Accept**: Not defined
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### HTTP response details
|
|
137
|
+
| Status code | Description | Response headers |
|
|
138
|
+
|-------------|-------------|------------------|
|
|
139
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
140
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
141
|
+
|
|
142
|
+
[[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)
|
|
143
|
+
|
|
144
|
+
# **onBidCanceled**
|
|
145
|
+
> onBidCanceled(onBidCanceledRequest)
|
|
146
|
+
|
|
147
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
148
|
+
|
|
149
|
+
### Example
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
import {
|
|
153
|
+
WebhooksApi,
|
|
154
|
+
Configuration,
|
|
155
|
+
OnBidCanceledRequest
|
|
156
|
+
} from '@cmarket/partner-sdk';
|
|
157
|
+
|
|
158
|
+
const configuration = new Configuration();
|
|
159
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
160
|
+
|
|
161
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
162
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
163
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
164
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
165
|
+
let onBidCanceledRequest: OnBidCanceledRequest; //
|
|
166
|
+
|
|
167
|
+
const { status, data } = await apiInstance.onBidCanceled(
|
|
168
|
+
webhookId,
|
|
169
|
+
webhookEventType,
|
|
170
|
+
webhookTimestamp,
|
|
171
|
+
webhookSignature,
|
|
172
|
+
onBidCanceledRequest
|
|
173
|
+
);
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
|Name | Type | Description | Notes|
|
|
179
|
+
|------------- | ------------- | ------------- | -------------|
|
|
180
|
+
| **onBidCanceledRequest** | **OnBidCanceledRequest**| | |
|
|
181
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
182
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
183
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
184
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
### Return type
|
|
188
|
+
|
|
189
|
+
void (empty response body)
|
|
190
|
+
|
|
191
|
+
### Authorization
|
|
192
|
+
|
|
193
|
+
No authorization required
|
|
194
|
+
|
|
195
|
+
### HTTP request headers
|
|
196
|
+
|
|
197
|
+
- **Content-Type**: application/json
|
|
198
|
+
- **Accept**: Not defined
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
### HTTP response details
|
|
202
|
+
| Status code | Description | Response headers |
|
|
203
|
+
|-------------|-------------|------------------|
|
|
204
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
205
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
206
|
+
|
|
207
|
+
[[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)
|
|
208
|
+
|
|
209
|
+
# **onBidClosed**
|
|
210
|
+
> onBidClosed(onBidClosedRequest)
|
|
211
|
+
|
|
212
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
213
|
+
|
|
214
|
+
### Example
|
|
215
|
+
|
|
216
|
+
```typescript
|
|
217
|
+
import {
|
|
218
|
+
WebhooksApi,
|
|
219
|
+
Configuration,
|
|
220
|
+
OnBidClosedRequest
|
|
221
|
+
} from '@cmarket/partner-sdk';
|
|
222
|
+
|
|
223
|
+
const configuration = new Configuration();
|
|
224
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
225
|
+
|
|
226
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
227
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
228
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
229
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
230
|
+
let onBidClosedRequest: OnBidClosedRequest; //
|
|
231
|
+
|
|
232
|
+
const { status, data } = await apiInstance.onBidClosed(
|
|
233
|
+
webhookId,
|
|
234
|
+
webhookEventType,
|
|
235
|
+
webhookTimestamp,
|
|
236
|
+
webhookSignature,
|
|
237
|
+
onBidClosedRequest
|
|
238
|
+
);
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### Parameters
|
|
242
|
+
|
|
243
|
+
|Name | Type | Description | Notes|
|
|
244
|
+
|------------- | ------------- | ------------- | -------------|
|
|
245
|
+
| **onBidClosedRequest** | **OnBidClosedRequest**| | |
|
|
246
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
247
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
248
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
249
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
void (empty response body)
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
No authorization required
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: application/json
|
|
263
|
+
- **Accept**: Not defined
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### HTTP response details
|
|
267
|
+
| Status code | Description | Response headers |
|
|
268
|
+
|-------------|-------------|------------------|
|
|
269
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
270
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
271
|
+
|
|
272
|
+
[[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)
|
|
273
|
+
|
|
274
|
+
# **onBidFailed**
|
|
275
|
+
> onBidFailed(onBidFailedRequest)
|
|
276
|
+
|
|
277
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
278
|
+
|
|
279
|
+
### Example
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
import {
|
|
283
|
+
WebhooksApi,
|
|
284
|
+
Configuration,
|
|
285
|
+
OnBidFailedRequest
|
|
286
|
+
} from '@cmarket/partner-sdk';
|
|
287
|
+
|
|
288
|
+
const configuration = new Configuration();
|
|
289
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
290
|
+
|
|
291
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
292
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
293
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
294
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
295
|
+
let onBidFailedRequest: OnBidFailedRequest; //
|
|
296
|
+
|
|
297
|
+
const { status, data } = await apiInstance.onBidFailed(
|
|
298
|
+
webhookId,
|
|
299
|
+
webhookEventType,
|
|
300
|
+
webhookTimestamp,
|
|
301
|
+
webhookSignature,
|
|
302
|
+
onBidFailedRequest
|
|
303
|
+
);
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Parameters
|
|
307
|
+
|
|
308
|
+
|Name | Type | Description | Notes|
|
|
309
|
+
|------------- | ------------- | ------------- | -------------|
|
|
310
|
+
| **onBidFailedRequest** | **OnBidFailedRequest**| | |
|
|
311
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
312
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
313
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
314
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
### Return type
|
|
318
|
+
|
|
319
|
+
void (empty response body)
|
|
320
|
+
|
|
321
|
+
### Authorization
|
|
322
|
+
|
|
323
|
+
No authorization required
|
|
324
|
+
|
|
325
|
+
### HTTP request headers
|
|
326
|
+
|
|
327
|
+
- **Content-Type**: application/json
|
|
328
|
+
- **Accept**: Not defined
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
### HTTP response details
|
|
332
|
+
| Status code | Description | Response headers |
|
|
333
|
+
|-------------|-------------|------------------|
|
|
334
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
335
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
336
|
+
|
|
337
|
+
[[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)
|
|
338
|
+
|
|
339
|
+
# **onPing**
|
|
340
|
+
> onPing(onPingRequest)
|
|
341
|
+
|
|
342
|
+
발송자 User-Agent 는 `cmarket-webhooks/1` 입니다. **서명 검증은 원문 바이트로 하세요.** JSON 을 파싱한 뒤 다시 직렬화하면 키 순서·공백이 달라져 서명이 어긋납니다. **서명 규약은 [Standard Webhooks](https://www.standardwebhooks.com) 입니다** — 검증을 직접 짜지 말고 각 언어의 `standardwebhooks` 라이브러리에 발급받은 시크릿(`whsec_…`)을 그대로 넘기세요. **재시도는 at-least-once 입니다.** 같은 이벤트가 두 번 올 수 있으니 `webhook-id` 로 중복 제거하세요. **본문에는 최소 정보만 담깁니다.** 상세는 이벤트를 받은 뒤 해당 조회 엔드포인트로 가져오세요 — 같은 사실을 두 곳이 각자 표현하면 갈라집니다.
|
|
343
|
+
|
|
344
|
+
### Example
|
|
345
|
+
|
|
346
|
+
```typescript
|
|
347
|
+
import {
|
|
348
|
+
WebhooksApi,
|
|
349
|
+
Configuration,
|
|
350
|
+
OnPingRequest
|
|
351
|
+
} from '@cmarket/partner-sdk';
|
|
352
|
+
|
|
353
|
+
const configuration = new Configuration();
|
|
354
|
+
const apiInstance = new WebhooksApi(configuration);
|
|
355
|
+
|
|
356
|
+
let webhookId: string; //이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. (default to undefined)
|
|
357
|
+
let webhookEventType: string; //이벤트 타입. 본문 `type` 과 같습니다. (default to undefined)
|
|
358
|
+
let webhookTimestamp: string; //서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. (default to undefined)
|
|
359
|
+
let webhookSignature: string; //`v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. (default to undefined)
|
|
360
|
+
let onPingRequest: OnPingRequest; //
|
|
361
|
+
|
|
362
|
+
const { status, data } = await apiInstance.onPing(
|
|
363
|
+
webhookId,
|
|
364
|
+
webhookEventType,
|
|
365
|
+
webhookTimestamp,
|
|
366
|
+
webhookSignature,
|
|
367
|
+
onPingRequest
|
|
368
|
+
);
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Parameters
|
|
372
|
+
|
|
373
|
+
|Name | Type | Description | Notes|
|
|
374
|
+
|------------- | ------------- | ------------- | -------------|
|
|
375
|
+
| **onPingRequest** | **OnPingRequest**| | |
|
|
376
|
+
| **webhookId** | [**string**] | 이벤트 식별자. **재시도에도 같은 값**이므로 수신측 중복 제거 키로 쓰세요. | defaults to undefined|
|
|
377
|
+
| **webhookEventType** | [**string**] | 이벤트 타입. 본문 `type` 과 같습니다. | defaults to undefined|
|
|
378
|
+
| **webhookTimestamp** | [**string**] | 서명 타임스탬프(unix 초). 현재 시각에서 300초 이상 지난 요청은 재전송으로 보고 거절하세요. | defaults to undefined|
|
|
379
|
+
| **webhookSignature** | [**string**] | `v1,<base64 hmac-sha256>`(Standard Webhooks). 서명 대상은 `\"{webhook-id}.{webhook-timestamp}.{원문 본문}\"` 이고, HMAC 키는 시크릿 문자열이 아니라 `whsec_` 를 뗀 뒤 base64 디코드한 바이트입니다. 공백으로 구분된 여러 서명이 올 수 있으니(키 회전) **하나라도 맞으면 통과**로 처리하세요. 직접 구현하지 말고 각 언어의 `standardwebhooks` 라이브러리를 쓰는 것을 권합니다. | defaults to undefined|
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
void (empty response body)
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
No authorization required
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: application/json
|
|
393
|
+
- **Accept**: Not defined
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
### HTTP response details
|
|
397
|
+
| Status code | Description | Response headers |
|
|
398
|
+
|-------------|-------------|------------------|
|
|
399
|
+
|**200** | 수신 성공. **2xx 면 무엇이든 성공**으로 기록합니다. 본문은 읽지 않으므로 비워도 됩니다. 처리에 시간이 걸리면 먼저 2xx 로 응답하고 비동기로 처리하세요 — 응답이 늦으면 타임아웃으로 재시도가 걸립니다. | - |
|
|
400
|
+
|**0** | 2xx 가 아니면 실패로 기록하고 재시도합니다(7회, 간격 10·60·300·1800·7200·21600·86400초). 연속 실패가 20회에 도달하면 구독이 `DISABLED` 로 내려갑니다. | - |
|
|
401
|
+
|
|
402
|
+
[[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)
|
|
403
|
+
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* 외부 ERP 연동용 RESTful API. ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요. ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다. 대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요. ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다. 봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다. 에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다. ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다. ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음). `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다. ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요. ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다. `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요. ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다. ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요. ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* 외부 ERP 연동용 RESTful API. ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요. ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다. 대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요. ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다. 봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다. 에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다. ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다. ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음). `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다. ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요. ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다. `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요. ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다. ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요. ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* 외부 ERP 연동용 RESTful API. ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요. ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다. 대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요. ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다. 봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다. 에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다. ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다. ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음). `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다. ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요. ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다. `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요. ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다. ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요. ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* 외부 ERP 연동용 RESTful API. ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요. ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다. 대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요. ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다. 봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다. 에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다. ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다. ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음). `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다. ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요. ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다. `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요. ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다. ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요. ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* 외부 ERP 연동용 RESTful API. ## 인증 OAuth2 Bearer JWT (`client_credentials` 플로우). `/oauth/token` 에서 토큰을 발급받아 `Authorization: Bearer <token>` 헤더로 실으세요. ## 권한 — 두 개의 독립된 축 `403` 을 만났다면 둘 중 어느 축에 걸린 것인지 먼저 구분하세요. - **스코프** = *무엇을 할 수 있나*. 토큰에 부여된 `bids:read`·`contracts:write` 등입니다. 미보유 시 `…/insufficient-scope`. - **대행 범위** = *누구의 데이터를 다룰 수 있나*. API 키 설정이며 스코프로 표현되지 않습니다. 범위 밖이면 스코프와 무관하게 403 입니다. 대행 범위는 키마다 둘 중 하나로 설정됩니다 — **소속 그룹 전원**(기관 키. 사업처·부서 계정이 새로 생겨도 자동 포함) 또는 **지정 발주처 목록**(계약으로 합의된 목록). 범위를 넓혀야 하면 스코프가 아니라 키 설정 변경을 요청하세요. ## 성공 응답 봉투 `/v2` 의 모든 2xx 본문은 `{ \"data\": … }` 입니다. 단일 리소스든 목록이든 같습니다. **목록은 `data` 가 배열이고 `meta` 가 항상 함께 실립니다** — `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. 단일 리소스 응답에는 `meta` 가 나가지 않습니다. 봉투를 쓰지 않는 표면은 둘입니다. `/oauth/_*` 와 `/.well-known/_*` 는 각각 RFC 6749·RFC 8414·RFC 9728 이 최상위 필드를 규정하고, 파일 내용 응답은 본문이 JSON 이 아닙니다. 에러 응답에는 봉투를 씌우지 않습니다 — 아래 problem+json 이 단독으로 책임집니다. ## 조건부 요청 (ETag) `/v2` 의 모든 `GET` 응답에 weak `ETag`(`W/\"…\"`)가 실립니다. 받은 값을 다음 요청의 `If-None-Match` 헤더로 되보내면, 내용이 그대로일 때 `304 Not Modified` 를 본문 없이 받습니다. 결과가 나기를 기다리며 같은 자원을 반복 조회하는 연동이라면 이 헤더 하나로 전송량이 사라집니다. ## 에러 (RFC 9457 problem+json) 모든 에러 응답은 `application/problem+json` 입니다. **HTTP status + `type` URI** 로 분기하세요. - `retryable`(boolean): 자동 재시도 안전 여부. `true`(429·5xx transient)면 backoff 후 재시도하고, `false`면 요청을 고쳐야 합니다. - `traceId`: 요청 추적 id. `X-Correlation-Id` 응답 헤더와 같은 값입니다 — 문의할 때 이 값을 첨부하세요. - `correlationId`: `traceId` 와 같은 값의 옛 이름. 기존 연동 호환으로 함께 실립니다. 새 연동은 `traceId` 를 읽으세요. - `invalid-params`: 검증 실패(400 `…/validation-failed`) 시 위반 필드 경로 목록(RFC 9457 확장, 값 없음). `type` 은 `https://problems.cmarket.io/partner/<slug>` 형태의 **안정 식별자**입니다. RFC 9457 §3.1.1 이 허용하는 대로 이 URI 는 **역참조(dereference)되지 않습니다** — 브라우저로 열지 말고 문자열 비교로만 쓰세요. slug 목록과 의미는 각 엔드포인트의 응답 설명에 status 별로 적혀 있습니다. ### 멱등성 위반: 409 와 422 의 차이 - `409` `…/idempotency-key-conflict` — 같은 키의 **원 요청이 아직 처리 중**입니다. 잠시 뒤 같은 키로 다시 부르면 그 결과를 받습니다. - `422` `…/idempotency-key-reused` — 같은 키를 **다른 body** 로 보냈습니다. 재시도해도 영원히 같은 실패이니 새 키를 쓰거나 body 를 되돌리세요. ## Rate Limit 전역 **60 요청/분 per `client_id`**, 토큰 발급(`/oauth/token`)은 **5 요청/분** 입니다. 초과 시 `429`(`type: …/too-many-requests`). 쿼터는 두 가지 표기로 함께 나갑니다 — 신규 연동은 표준 필드를 쓰세요. - **표준**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (정책) · `RateLimit: \"default\";r=59;t=42` (잔량 r, 리셋까지 t 초) - **레거시**(관용): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. 기존 연동 호환을 위해 유지합니다. `429` 에서는 `Retry-After`(초)가 우선합니다. 대량 동기화(품목 단위 반복 등록 등)는 `Retry-After` 만큼 backoff 후 재시도하세요. ## 추적 요청에 `X-Correlation-Id` 헤더를 실으면 그대로 echo 되고, 없으면 서버가 발급합니다. 모든 응답(성공/에러)에 `X-Correlation-Id` 가 실립니다. ## 전방호환 — 모르는 필드와 값에서 깨지지 않게 다음 셋은 breaking 변경으로 보지 않으며 minor 릴리스에서 예고 없이 일어납니다. 이 전제로 구현하세요. - **선택 필드 추가**: 모르는 필드는 무시하세요. 엄격 파서(unknown key 거부)를 쓰지 마세요. - **enum 값 추가**: 상태·낙찰방법 등에 새 값이 생깁니다. 모르는 값을 만나면 예외를 던지지 말고 원문 문자열을 보존하세요. - **problem `type` slug 추가**: 모르는 slug 은 **HTTP status 로 폴백**해 분기하세요. ## 버전 수명(deprecation/sunset) - **_/v2** breaking 변경은 CHANGELOG SemVer(major bump)와 `Deprecation`/`Sunset` 헤더로 통지합니다. 이 헤더를 모니터링하세요.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|