@cmarket/partner-sdk 39.0.0 β 40.0.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 +9 -6
- package/api/embed-api.ts +10 -10
- package/api/oauth-api.ts +18 -18
- package/api/partner-api-api.ts +334 -334
- package/api/products-api.ts +22 -22
- package/api/webhooks-api.ts +78 -78
- package/api/well-known-api.ts +10 -10
- package/api.ts +2 -2
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api/embed-api.d.ts +10 -10
- package/dist/api/embed-api.js +10 -10
- package/dist/api/oauth-api.d.ts +18 -18
- package/dist/api/oauth-api.js +18 -18
- package/dist/api/partner-api-api.d.ts +334 -334
- package/dist/api/partner-api-api.js +334 -334
- package/dist/api/products-api.d.ts +22 -22
- package/dist/api/products-api.js +22 -22
- package/dist/api/webhooks-api.d.ts +78 -78
- package/dist/api/webhooks-api.js +78 -78
- package/dist/api/well-known-api.d.ts +10 -10
- package/dist/api/well-known-api.js +10 -10
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api/embed-api.d.ts +10 -10
- package/dist/esm/api/embed-api.js +10 -10
- package/dist/esm/api/oauth-api.d.ts +18 -18
- package/dist/esm/api/oauth-api.js +18 -18
- package/dist/esm/api/partner-api-api.d.ts +334 -334
- package/dist/esm/api/partner-api-api.js +334 -334
- package/dist/esm/api/products-api.d.ts +22 -22
- package/dist/esm/api/products-api.js +22 -22
- package/dist/esm/api/webhooks-api.d.ts +78 -78
- package/dist/esm/api/webhooks-api.js +78 -78
- package/dist/esm/api/well-known-api.d.ts +10 -10
- package/dist/esm/api/well-known-api.js +10 -10
- package/dist/esm/api.d.ts +2 -2
- package/dist/esm/api.js +2 -2
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/esm/models/acceptance-result-response-dto.d.ts +2 -2
- package/dist/esm/models/acceptance-result-response-dto.js +2 -2
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +2 -2
- package/dist/esm/models/acknowledge-product-receipt200-response.js +2 -2
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +3 -3
- package/dist/esm/models/acknowledge-products-request-dto.js +2 -2
- package/dist/esm/models/api-catalog-dto.d.ts +2 -2
- package/dist/esm/models/api-catalog-dto.js +2 -2
- package/dist/esm/models/api-catalog-entry-dto.d.ts +4 -4
- package/dist/esm/models/api-catalog-entry-dto.js +2 -2
- package/dist/esm/models/api-catalog-link-dto.d.ts +2 -2
- package/dist/esm/models/api-catalog-link-dto.js +2 -2
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +6 -6
- package/dist/esm/models/authorization-server-metadata-dto.js +2 -2
- package/dist/esm/models/award-method-public.d.ts +2 -2
- package/dist/esm/models/award-method-public.js +2 -2
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +3 -3
- package/dist/esm/models/award-registered-v2-response-dto.js +2 -2
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +3 -3
- package/dist/esm/models/award-reverted-v2-response-dto.js +2 -2
- package/dist/esm/models/bid-acceptance-dto.d.ts +2 -2
- package/dist/esm/models/bid-acceptance-dto.js +2 -2
- package/dist/esm/models/bid-attachment-input-dto.d.ts +6 -6
- package/dist/esm/models/bid-attachment-input-dto.js +2 -2
- package/dist/esm/models/bid-bond-dto.d.ts +2 -2
- package/dist/esm/models/bid-bond-dto.js +2 -2
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +3 -3
- package/dist/esm/models/bid-cancelled-response-dto.js +2 -2
- package/dist/esm/models/bid-contact-dto.d.ts +2 -2
- package/dist/esm/models/bid-contact-dto.js +2 -2
- package/dist/esm/models/bid-contacts-dto.d.ts +2 -2
- package/dist/esm/models/bid-contacts-dto.js +2 -2
- package/dist/esm/models/bid-contract-document-dto.d.ts +9 -9
- package/dist/esm/models/bid-contract-document-dto.js +2 -2
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +2 -2
- package/dist/esm/models/bid-delivery-terms-dto.js +2 -2
- package/dist/esm/models/bid-detail-response-dto.d.ts +5 -5
- package/dist/esm/models/bid-detail-response-dto.js +2 -2
- package/dist/esm/models/bid-document-dto.d.ts +2 -2
- package/dist/esm/models/bid-document-dto.js +2 -2
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +3 -3
- package/dist/esm/models/bid-failed-v2-response-dto.js +2 -2
- package/dist/esm/models/bid-item-dto.d.ts +2 -2
- package/dist/esm/models/bid-item-dto.js +2 -2
- package/dist/esm/models/bid-lifecycle-dto.d.ts +2 -2
- package/dist/esm/models/bid-lifecycle-dto.js +2 -2
- package/dist/esm/models/bid-manager-dto.d.ts +2 -2
- package/dist/esm/models/bid-manager-dto.js +2 -2
- package/dist/esm/models/bid-payment-terms-dto.d.ts +2 -2
- package/dist/esm/models/bid-payment-terms-dto.js +2 -2
- package/dist/esm/models/bid-product-dto.d.ts +2 -2
- package/dist/esm/models/bid-product-dto.js +2 -2
- package/dist/esm/models/bid-public-status.d.ts +2 -2
- package/dist/esm/models/bid-public-status.js +2 -2
- package/dist/esm/models/bid-registered-response-dto.d.ts +3 -3
- package/dist/esm/models/bid-registered-response-dto.js +2 -2
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +3 -3
- package/dist/esm/models/bid-result-participant-attachment-dto.js +2 -2
- package/dist/esm/models/bid-result-participant-dto.d.ts +3 -3
- package/dist/esm/models/bid-result-participant-dto.js +2 -2
- package/dist/esm/models/bid-results-response-dto.d.ts +5 -5
- package/dist/esm/models/bid-results-response-dto.js +2 -2
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-line-item-dto.js +2 -2
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-participant-dto.js +2 -2
- package/dist/esm/models/bid-settlement-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-settlement-response-dto.js +2 -2
- package/dist/esm/models/bid-statement-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-statement-response-dto.js +2 -2
- package/dist/esm/models/bid-summary-dto.d.ts +3 -3
- package/dist/esm/models/bid-summary-dto.js +2 -2
- package/dist/esm/models/bid-type-public.d.ts +2 -2
- package/dist/esm/models/bid-type-public.js +2 -2
- package/dist/esm/models/bid-updated-response-dto.d.ts +2 -2
- package/dist/esm/models/bid-updated-response-dto.js +2 -2
- package/dist/esm/models/cancel-bid-request-dto.d.ts +2 -2
- package/dist/esm/models/cancel-bid-request-dto.js +2 -2
- package/dist/esm/models/cancel-bid200-response.d.ts +2 -2
- package/dist/esm/models/cancel-bid200-response.js +2 -2
- package/dist/esm/models/card-payment-request-response-dto.d.ts +2 -2
- package/dist/esm/models/card-payment-request-response-dto.js +2 -2
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +4 -4
- package/dist/esm/models/complete-acceptance-request-dto.js +2 -2
- package/dist/esm/models/complete-acceptance200-response.d.ts +2 -2
- package/dist/esm/models/complete-acceptance200-response.js +2 -2
- package/dist/esm/models/complete-invoice200-response.d.ts +2 -2
- package/dist/esm/models/complete-invoice200-response.js +2 -2
- package/dist/esm/models/complete-upload-request-dto.d.ts +2 -2
- package/dist/esm/models/complete-upload-request-dto.js +2 -2
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +3 -3
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +2 -2
- package/dist/esm/models/create-bid-request-dto.d.ts +5 -5
- package/dist/esm/models/create-bid-request-dto.js +2 -2
- package/dist/esm/models/create-card-payment-dto.d.ts +2 -2
- package/dist/esm/models/create-card-payment-dto.js +2 -2
- package/dist/esm/models/create-card-payment-request-dto.d.ts +2 -2
- package/dist/esm/models/create-card-payment-request-dto.js +2 -2
- package/dist/esm/models/create-card-payment200-response.d.ts +2 -2
- package/dist/esm/models/create-card-payment200-response.js +2 -2
- package/dist/esm/models/create-embed-launch201-response.d.ts +2 -2
- package/dist/esm/models/create-embed-launch201-response.js +2 -2
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +4 -4
- package/dist/esm/models/create-external-contract-documents-request-dto.js +2 -2
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +2 -2
- package/dist/esm/models/create-external-contract-documents-response-dto.js +2 -2
- package/dist/esm/models/create-file-upload-url201-response.d.ts +2 -2
- package/dist/esm/models/create-file-upload-url201-response.js +2 -2
- package/dist/esm/models/create-upload-url-request-dto.d.ts +2 -2
- package/dist/esm/models/create-upload-url-request-dto.js +2 -2
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +4 -4
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +2 -2
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +2 -2
- package/dist/esm/models/create-webhook-endpoint201-response.js +2 -2
- package/dist/esm/models/delivery-date-type-public.d.ts +2 -2
- package/dist/esm/models/delivery-date-type-public.js +2 -2
- package/dist/esm/models/delivery-method-public.d.ts +2 -2
- package/dist/esm/models/delivery-method-public.js +2 -2
- package/dist/esm/models/embed-bid-prefill-dto.d.ts +83 -0
- package/dist/esm/models/embed-bid-prefill-dto.js +23 -0
- package/dist/esm/models/embed-bid-prefill-item-dto.d.ts +33 -0
- package/dist/esm/models/embed-bid-prefill-item-dto.js +14 -0
- package/dist/esm/models/embed-bid-prefill-manager-dto.d.ts +25 -0
- package/dist/esm/models/embed-bid-prefill-manager-dto.js +14 -0
- package/dist/esm/models/embed-launch-request-dto.d.ts +10 -9
- package/dist/esm/models/embed-launch-request-dto.js +2 -2
- package/dist/esm/models/embed-launch-response-dto.d.ts +4 -4
- package/dist/esm/models/embed-launch-response-dto.js +2 -2
- package/dist/esm/models/excellent-procurement-public.d.ts +2 -2
- package/dist/esm/models/excellent-procurement-public.js +2 -2
- package/dist/esm/models/external-contract-document-item-dto.d.ts +3 -3
- package/dist/esm/models/external-contract-document-item-dto.js +2 -2
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-documents-response-dto.js +2 -2
- package/dist/esm/models/external-contract-item-dto.d.ts +2 -2
- package/dist/esm/models/external-contract-item-dto.js +2 -2
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +5 -5
- package/dist/esm/models/external-contract-snapshot-dto.js +2 -2
- package/dist/esm/models/external-document-inputs-dto.d.ts +2 -2
- package/dist/esm/models/external-document-inputs-dto.js +2 -2
- package/dist/esm/models/file-meta-response-dto.d.ts +2 -2
- package/dist/esm/models/file-meta-response-dto.js +2 -2
- package/dist/esm/models/file-uploaded-response-dto.d.ts +2 -2
- package/dist/esm/models/file-uploaded-response-dto.js +2 -2
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +4 -4
- package/dist/esm/models/generated-external-contract-document-dto.js +2 -2
- package/dist/esm/models/get-bid-settlement200-response.d.ts +2 -2
- package/dist/esm/models/get-bid-settlement200-response.js +2 -2
- package/dist/esm/models/get-bid-statement200-response.d.ts +2 -2
- package/dist/esm/models/get-bid-statement200-response.js +2 -2
- package/dist/esm/models/get-bid200-response.d.ts +2 -2
- package/dist/esm/models/get-bid200-response.js +2 -2
- package/dist/esm/models/get-file-meta200-response.d.ts +2 -2
- package/dist/esm/models/get-file-meta200-response.js +2 -2
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +2 -2
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +2 -2
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +2 -2
- package/dist/esm/models/get-webhook-endpoint200-response.js +2 -2
- package/dist/esm/models/green-product-public.d.ts +2 -2
- package/dist/esm/models/green-product-public.js +2 -2
- package/dist/esm/models/health-controller-check200-response.d.ts +2 -2
- package/dist/esm/models/health-controller-check200-response.js +2 -2
- package/dist/esm/models/health-response-dto.d.ts +2 -2
- package/dist/esm/models/health-response-dto.js +2 -2
- package/dist/esm/models/hierarchical-region-dto.d.ts +2 -2
- package/dist/esm/models/hierarchical-region-dto.js +2 -2
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/models/introspect-request-dto.d.ts +5 -5
- package/dist/esm/models/introspect-request-dto.js +2 -2
- package/dist/esm/models/introspection-response-dto.d.ts +4 -4
- package/dist/esm/models/introspection-response-dto.js +2 -2
- package/dist/esm/models/invalid-param-dto.d.ts +2 -2
- package/dist/esm/models/invalid-param-dto.js +2 -2
- package/dist/esm/models/invoice-completed-response-dto.d.ts +2 -2
- package/dist/esm/models/invoice-completed-response-dto.js +2 -2
- package/dist/esm/models/invoice-split-response-dto.d.ts +2 -2
- package/dist/esm/models/invoice-split-response-dto.js +2 -2
- package/dist/esm/models/legal-mandatory-public.d.ts +2 -2
- package/dist/esm/models/legal-mandatory-public.js +2 -2
- package/dist/esm/models/list-bid-results200-response.d.ts +2 -2
- package/dist/esm/models/list-bid-results200-response.js +2 -2
- package/dist/esm/models/list-bids200-response-meta.d.ts +3 -3
- package/dist/esm/models/list-bids200-response-meta.js +2 -2
- package/dist/esm/models/list-bids200-response.d.ts +2 -2
- package/dist/esm/models/list-bids200-response.js +2 -2
- package/dist/esm/models/list-products200-response.d.ts +2 -2
- package/dist/esm/models/list-products200-response.js +2 -2
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +3 -3
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +2 -2
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +2 -2
- package/dist/esm/models/list-webhook-deliveries200-response.js +2 -2
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +2 -2
- package/dist/esm/models/list-webhook-endpoints200-response.js +2 -2
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +2 -2
- package/dist/esm/models/mark-bid-failed-request-dto.js +2 -2
- package/dist/esm/models/mark-bid-failed201-response.d.ts +2 -2
- package/dist/esm/models/mark-bid-failed201-response.js +2 -2
- package/dist/esm/models/negotiation-score-dto.d.ts +2 -2
- package/dist/esm/models/negotiation-score-dto.js +2 -2
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +3 -3
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +2 -2
- package/dist/esm/models/oauth-error-response-dto.d.ts +2 -2
- package/dist/esm/models/oauth-error-response-dto.js +2 -2
- package/dist/esm/models/on-bid-award-reverted-request.d.ts +2 -2
- package/dist/esm/models/on-bid-award-reverted-request.js +2 -2
- package/dist/esm/models/on-bid-awarded-request.d.ts +2 -2
- package/dist/esm/models/on-bid-awarded-request.js +2 -2
- package/dist/esm/models/on-bid-canceled-request.d.ts +2 -2
- package/dist/esm/models/on-bid-canceled-request.js +2 -2
- package/dist/esm/models/on-bid-closed-request.d.ts +2 -2
- package/dist/esm/models/on-bid-closed-request.js +2 -2
- package/dist/esm/models/on-bid-failed-request.d.ts +2 -2
- package/dist/esm/models/on-bid-failed-request.js +2 -2
- package/dist/esm/models/on-ping-request.d.ts +2 -2
- package/dist/esm/models/on-ping-request.js +2 -2
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +2 -2
- package/dist/esm/models/partner-webhook-delivery-status.js +2 -2
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +3 -3
- package/dist/esm/models/partner-webhook-endpoint-status.js +3 -3
- package/dist/esm/models/partner-webhook-event-type.d.ts +2 -2
- package/dist/esm/models/partner-webhook-event-type.js +2 -2
- package/dist/esm/models/payment-method-public.d.ts +2 -2
- package/dist/esm/models/payment-method-public.js +2 -2
- package/dist/esm/models/preconditions-dto.d.ts +2 -2
- package/dist/esm/models/preconditions-dto.js +2 -2
- package/dist/esm/models/problem-details-dto.d.ts +3 -3
- package/dist/esm/models/problem-details-dto.js +2 -2
- package/dist/esm/models/product-receipt-response-dto.d.ts +2 -2
- package/dist/esm/models/product-receipt-response-dto.js +2 -2
- package/dist/esm/models/product-response-dto.d.ts +3 -3
- package/dist/esm/models/product-response-dto.js +2 -2
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +6 -6
- package/dist/esm/models/protected-resource-metadata-dto.js +2 -2
- package/dist/esm/models/register-award-request-dto.d.ts +5 -5
- package/dist/esm/models/register-award-request-dto.js +2 -2
- package/dist/esm/models/register-award201-response.d.ts +2 -2
- package/dist/esm/models/register-award201-response.js +2 -2
- package/dist/esm/models/register-bid201-response.d.ts +2 -2
- package/dist/esm/models/register-bid201-response.js +2 -2
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +5 -5
- package/dist/esm/models/register-semo-contract-request-dto.js +2 -2
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +4 -4
- package/dist/esm/models/request-invoice-split-request-dto.js +2 -2
- package/dist/esm/models/request-invoice-split200-response.d.ts +2 -2
- package/dist/esm/models/request-invoice-split200-response.js +2 -2
- package/dist/esm/models/retiree-roster-input-dto.d.ts +2 -2
- package/dist/esm/models/retiree-roster-input-dto.js +2 -2
- package/dist/esm/models/retiree-roster-row-dto.d.ts +2 -2
- package/dist/esm/models/retiree-roster-row-dto.js +2 -2
- package/dist/esm/models/revert-award-request-dto.d.ts +2 -2
- package/dist/esm/models/revert-award-request-dto.js +2 -2
- package/dist/esm/models/revert-award200-response.d.ts +2 -2
- package/dist/esm/models/revert-award200-response.js +2 -2
- package/dist/esm/models/revoke-request-dto.d.ts +5 -5
- package/dist/esm/models/revoke-request-dto.js +2 -2
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +3 -3
- package/dist/esm/models/semo-contract-registered-response-dto.js +2 -2
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +2 -2
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +2 -2
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +2 -2
- package/dist/esm/models/send-webhook-test-event200-response.js +2 -2
- package/dist/esm/models/statement-document-dto.d.ts +3 -3
- package/dist/esm/models/statement-document-dto.js +2 -2
- package/dist/esm/models/statement-product-dto.d.ts +2 -2
- package/dist/esm/models/statement-product-dto.js +2 -2
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +2 -2
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +2 -2
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +2 -2
- package/dist/esm/models/submit-negotiation-scores201-response.js +2 -2
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +2 -2
- package/dist/esm/models/supplier-card-payable-response-dto.js +2 -2
- package/dist/esm/models/supplier-tax-type.d.ts +2 -2
- package/dist/esm/models/supplier-tax-type.js +2 -2
- package/dist/esm/models/token-request-dto.d.ts +5 -5
- package/dist/esm/models/token-request-dto.js +2 -2
- package/dist/esm/models/token-response-dto.d.ts +3 -3
- package/dist/esm/models/token-response-dto.js +2 -2
- package/dist/esm/models/update-bid-request-dto.d.ts +5 -5
- package/dist/esm/models/update-bid-request-dto.js +2 -2
- package/dist/esm/models/update-bid200-response.d.ts +2 -2
- package/dist/esm/models/update-bid200-response.js +2 -2
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +3 -3
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +2 -2
- package/dist/esm/models/upload-file-request-dto.d.ts +4 -4
- package/dist/esm/models/upload-file-request-dto.js +2 -2
- package/dist/esm/models/upload-file201-response.d.ts +2 -2
- package/dist/esm/models/upload-file201-response.js +2 -2
- package/dist/esm/models/upload-url-created-response-dto.d.ts +5 -5
- package/dist/esm/models/upload-url-created-response-dto.js +2 -2
- package/dist/esm/models/webhook-bid-event-data.d.ts +3 -3
- package/dist/esm/models/webhook-bid-event-data.js +2 -2
- package/dist/esm/models/webhook-delivery-dto.d.ts +4 -4
- package/dist/esm/models/webhook-delivery-dto.js +2 -2
- package/dist/esm/models/webhook-endpoint-dto.d.ts +6 -6
- package/dist/esm/models/webhook-endpoint-dto.js +2 -2
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +6 -6
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +2 -2
- package/dist/esm/models/webhook-event-envelope.d.ts +3 -3
- package/dist/esm/models/webhook-event-envelope.js +2 -2
- package/dist/esm/models/webhook-ping-event-data.d.ts +2 -2
- package/dist/esm/models/webhook-ping-event-data.js +2 -2
- package/dist/esm/models/webhook-test-result-dto.d.ts +3 -3
- package/dist/esm/models/webhook-test-result-dto.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/models/acceptance-result-response-dto.d.ts +2 -2
- package/dist/models/acceptance-result-response-dto.js +2 -2
- package/dist/models/acknowledge-product-receipt200-response.d.ts +2 -2
- package/dist/models/acknowledge-product-receipt200-response.js +2 -2
- package/dist/models/acknowledge-products-request-dto.d.ts +3 -3
- package/dist/models/acknowledge-products-request-dto.js +2 -2
- package/dist/models/api-catalog-dto.d.ts +2 -2
- package/dist/models/api-catalog-dto.js +2 -2
- package/dist/models/api-catalog-entry-dto.d.ts +4 -4
- package/dist/models/api-catalog-entry-dto.js +2 -2
- package/dist/models/api-catalog-link-dto.d.ts +2 -2
- package/dist/models/api-catalog-link-dto.js +2 -2
- package/dist/models/authorization-server-metadata-dto.d.ts +6 -6
- package/dist/models/authorization-server-metadata-dto.js +2 -2
- package/dist/models/award-method-public.d.ts +2 -2
- package/dist/models/award-method-public.js +2 -2
- package/dist/models/award-registered-v2-response-dto.d.ts +3 -3
- package/dist/models/award-registered-v2-response-dto.js +2 -2
- package/dist/models/award-reverted-v2-response-dto.d.ts +3 -3
- package/dist/models/award-reverted-v2-response-dto.js +2 -2
- package/dist/models/bid-acceptance-dto.d.ts +2 -2
- package/dist/models/bid-acceptance-dto.js +2 -2
- package/dist/models/bid-attachment-input-dto.d.ts +6 -6
- package/dist/models/bid-attachment-input-dto.js +2 -2
- package/dist/models/bid-bond-dto.d.ts +2 -2
- package/dist/models/bid-bond-dto.js +2 -2
- package/dist/models/bid-cancelled-response-dto.d.ts +3 -3
- package/dist/models/bid-cancelled-response-dto.js +2 -2
- package/dist/models/bid-contact-dto.d.ts +2 -2
- package/dist/models/bid-contact-dto.js +2 -2
- package/dist/models/bid-contacts-dto.d.ts +2 -2
- package/dist/models/bid-contacts-dto.js +2 -2
- package/dist/models/bid-contract-document-dto.d.ts +9 -9
- package/dist/models/bid-contract-document-dto.js +2 -2
- package/dist/models/bid-delivery-terms-dto.d.ts +2 -2
- package/dist/models/bid-delivery-terms-dto.js +2 -2
- package/dist/models/bid-detail-response-dto.d.ts +5 -5
- package/dist/models/bid-detail-response-dto.js +2 -2
- package/dist/models/bid-document-dto.d.ts +2 -2
- package/dist/models/bid-document-dto.js +2 -2
- package/dist/models/bid-failed-v2-response-dto.d.ts +3 -3
- package/dist/models/bid-failed-v2-response-dto.js +2 -2
- package/dist/models/bid-item-dto.d.ts +2 -2
- package/dist/models/bid-item-dto.js +2 -2
- package/dist/models/bid-lifecycle-dto.d.ts +2 -2
- package/dist/models/bid-lifecycle-dto.js +2 -2
- package/dist/models/bid-manager-dto.d.ts +2 -2
- package/dist/models/bid-manager-dto.js +2 -2
- package/dist/models/bid-payment-terms-dto.d.ts +2 -2
- package/dist/models/bid-payment-terms-dto.js +2 -2
- package/dist/models/bid-product-dto.d.ts +2 -2
- package/dist/models/bid-product-dto.js +2 -2
- package/dist/models/bid-public-status.d.ts +2 -2
- package/dist/models/bid-public-status.js +2 -2
- package/dist/models/bid-registered-response-dto.d.ts +3 -3
- package/dist/models/bid-registered-response-dto.js +2 -2
- package/dist/models/bid-result-participant-attachment-dto.d.ts +3 -3
- package/dist/models/bid-result-participant-attachment-dto.js +2 -2
- package/dist/models/bid-result-participant-dto.d.ts +3 -3
- package/dist/models/bid-result-participant-dto.js +2 -2
- package/dist/models/bid-results-response-dto.d.ts +5 -5
- package/dist/models/bid-results-response-dto.js +2 -2
- package/dist/models/bid-settlement-line-item-dto.d.ts +2 -2
- package/dist/models/bid-settlement-line-item-dto.js +2 -2
- package/dist/models/bid-settlement-participant-dto.d.ts +2 -2
- package/dist/models/bid-settlement-participant-dto.js +2 -2
- package/dist/models/bid-settlement-response-dto.d.ts +2 -2
- package/dist/models/bid-settlement-response-dto.js +2 -2
- package/dist/models/bid-statement-response-dto.d.ts +2 -2
- package/dist/models/bid-statement-response-dto.js +2 -2
- package/dist/models/bid-summary-dto.d.ts +3 -3
- package/dist/models/bid-summary-dto.js +2 -2
- package/dist/models/bid-type-public.d.ts +2 -2
- package/dist/models/bid-type-public.js +2 -2
- package/dist/models/bid-updated-response-dto.d.ts +2 -2
- package/dist/models/bid-updated-response-dto.js +2 -2
- package/dist/models/cancel-bid-request-dto.d.ts +2 -2
- package/dist/models/cancel-bid-request-dto.js +2 -2
- package/dist/models/cancel-bid200-response.d.ts +2 -2
- package/dist/models/cancel-bid200-response.js +2 -2
- package/dist/models/card-payment-request-response-dto.d.ts +2 -2
- package/dist/models/card-payment-request-response-dto.js +2 -2
- package/dist/models/complete-acceptance-request-dto.d.ts +4 -4
- package/dist/models/complete-acceptance-request-dto.js +2 -2
- package/dist/models/complete-acceptance200-response.d.ts +2 -2
- package/dist/models/complete-acceptance200-response.js +2 -2
- package/dist/models/complete-invoice200-response.d.ts +2 -2
- package/dist/models/complete-invoice200-response.js +2 -2
- package/dist/models/complete-upload-request-dto.d.ts +2 -2
- package/dist/models/complete-upload-request-dto.js +2 -2
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +3 -3
- package/dist/models/contract-restriction-confirm-input-dto.js +2 -2
- package/dist/models/create-bid-request-dto.d.ts +5 -5
- package/dist/models/create-bid-request-dto.js +2 -2
- package/dist/models/create-card-payment-dto.d.ts +2 -2
- package/dist/models/create-card-payment-dto.js +2 -2
- package/dist/models/create-card-payment-request-dto.d.ts +2 -2
- package/dist/models/create-card-payment-request-dto.js +2 -2
- package/dist/models/create-card-payment200-response.d.ts +2 -2
- package/dist/models/create-card-payment200-response.js +2 -2
- package/dist/models/create-embed-launch201-response.d.ts +2 -2
- package/dist/models/create-embed-launch201-response.js +2 -2
- package/dist/models/create-external-contract-documents-request-dto.d.ts +4 -4
- package/dist/models/create-external-contract-documents-request-dto.js +2 -2
- package/dist/models/create-external-contract-documents-response-dto.d.ts +2 -2
- package/dist/models/create-external-contract-documents-response-dto.js +2 -2
- package/dist/models/create-file-upload-url201-response.d.ts +2 -2
- package/dist/models/create-file-upload-url201-response.js +2 -2
- package/dist/models/create-upload-url-request-dto.d.ts +2 -2
- package/dist/models/create-upload-url-request-dto.js +2 -2
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +4 -4
- package/dist/models/create-webhook-endpoint-request-dto.js +2 -2
- package/dist/models/create-webhook-endpoint201-response.d.ts +2 -2
- package/dist/models/create-webhook-endpoint201-response.js +2 -2
- package/dist/models/delivery-date-type-public.d.ts +2 -2
- package/dist/models/delivery-date-type-public.js +2 -2
- package/dist/models/delivery-method-public.d.ts +2 -2
- package/dist/models/delivery-method-public.js +2 -2
- package/dist/models/embed-bid-prefill-dto.d.ts +83 -0
- package/dist/models/embed-bid-prefill-dto.js +26 -0
- package/dist/models/embed-bid-prefill-item-dto.d.ts +33 -0
- package/dist/models/embed-bid-prefill-item-dto.js +15 -0
- package/dist/models/embed-bid-prefill-manager-dto.d.ts +25 -0
- package/dist/models/embed-bid-prefill-manager-dto.js +15 -0
- package/dist/models/embed-launch-request-dto.d.ts +10 -9
- package/dist/models/embed-launch-request-dto.js +2 -2
- package/dist/models/embed-launch-response-dto.d.ts +4 -4
- package/dist/models/embed-launch-response-dto.js +2 -2
- package/dist/models/excellent-procurement-public.d.ts +2 -2
- package/dist/models/excellent-procurement-public.js +2 -2
- package/dist/models/external-contract-document-item-dto.d.ts +3 -3
- package/dist/models/external-contract-document-item-dto.js +2 -2
- package/dist/models/external-contract-documents-response-dto.d.ts +2 -2
- package/dist/models/external-contract-documents-response-dto.js +2 -2
- package/dist/models/external-contract-item-dto.d.ts +2 -2
- package/dist/models/external-contract-item-dto.js +2 -2
- package/dist/models/external-contract-snapshot-dto.d.ts +5 -5
- package/dist/models/external-contract-snapshot-dto.js +2 -2
- package/dist/models/external-document-inputs-dto.d.ts +2 -2
- package/dist/models/external-document-inputs-dto.js +2 -2
- package/dist/models/file-meta-response-dto.d.ts +2 -2
- package/dist/models/file-meta-response-dto.js +2 -2
- package/dist/models/file-uploaded-response-dto.d.ts +2 -2
- package/dist/models/file-uploaded-response-dto.js +2 -2
- package/dist/models/generated-external-contract-document-dto.d.ts +4 -4
- package/dist/models/generated-external-contract-document-dto.js +2 -2
- package/dist/models/get-bid-settlement200-response.d.ts +2 -2
- package/dist/models/get-bid-settlement200-response.js +2 -2
- package/dist/models/get-bid-statement200-response.d.ts +2 -2
- package/dist/models/get-bid-statement200-response.js +2 -2
- package/dist/models/get-bid200-response.d.ts +2 -2
- package/dist/models/get-bid200-response.js +2 -2
- package/dist/models/get-file-meta200-response.d.ts +2 -2
- package/dist/models/get-file-meta200-response.js +2 -2
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +2 -2
- package/dist/models/get-supplier-card-payable-v2200-response.js +2 -2
- package/dist/models/get-webhook-endpoint200-response.d.ts +2 -2
- package/dist/models/get-webhook-endpoint200-response.js +2 -2
- package/dist/models/green-product-public.d.ts +2 -2
- package/dist/models/green-product-public.js +2 -2
- package/dist/models/health-controller-check200-response.d.ts +2 -2
- package/dist/models/health-controller-check200-response.js +2 -2
- package/dist/models/health-response-dto.d.ts +2 -2
- package/dist/models/health-response-dto.js +2 -2
- package/dist/models/hierarchical-region-dto.d.ts +2 -2
- package/dist/models/hierarchical-region-dto.js +2 -2
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/introspect-request-dto.d.ts +5 -5
- package/dist/models/introspect-request-dto.js +2 -2
- package/dist/models/introspection-response-dto.d.ts +4 -4
- package/dist/models/introspection-response-dto.js +2 -2
- package/dist/models/invalid-param-dto.d.ts +2 -2
- package/dist/models/invalid-param-dto.js +2 -2
- package/dist/models/invoice-completed-response-dto.d.ts +2 -2
- package/dist/models/invoice-completed-response-dto.js +2 -2
- package/dist/models/invoice-split-response-dto.d.ts +2 -2
- package/dist/models/invoice-split-response-dto.js +2 -2
- package/dist/models/legal-mandatory-public.d.ts +2 -2
- package/dist/models/legal-mandatory-public.js +2 -2
- package/dist/models/list-bid-results200-response.d.ts +2 -2
- package/dist/models/list-bid-results200-response.js +2 -2
- package/dist/models/list-bids200-response-meta.d.ts +3 -3
- package/dist/models/list-bids200-response-meta.js +2 -2
- package/dist/models/list-bids200-response.d.ts +2 -2
- package/dist/models/list-bids200-response.js +2 -2
- package/dist/models/list-products200-response.d.ts +2 -2
- package/dist/models/list-products200-response.js +2 -2
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +3 -3
- package/dist/models/list-webhook-deliveries-response-dto.js +2 -2
- package/dist/models/list-webhook-deliveries200-response.d.ts +2 -2
- package/dist/models/list-webhook-deliveries200-response.js +2 -2
- package/dist/models/list-webhook-endpoints200-response.d.ts +2 -2
- package/dist/models/list-webhook-endpoints200-response.js +2 -2
- package/dist/models/mark-bid-failed-request-dto.d.ts +2 -2
- package/dist/models/mark-bid-failed-request-dto.js +2 -2
- package/dist/models/mark-bid-failed201-response.d.ts +2 -2
- package/dist/models/mark-bid-failed201-response.js +2 -2
- package/dist/models/negotiation-score-dto.d.ts +2 -2
- package/dist/models/negotiation-score-dto.js +2 -2
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +3 -3
- package/dist/models/negotiation-scored-v2-response-dto.js +2 -2
- package/dist/models/oauth-error-response-dto.d.ts +2 -2
- package/dist/models/oauth-error-response-dto.js +2 -2
- package/dist/models/on-bid-award-reverted-request.d.ts +2 -2
- package/dist/models/on-bid-award-reverted-request.js +2 -2
- package/dist/models/on-bid-awarded-request.d.ts +2 -2
- package/dist/models/on-bid-awarded-request.js +2 -2
- package/dist/models/on-bid-canceled-request.d.ts +2 -2
- package/dist/models/on-bid-canceled-request.js +2 -2
- package/dist/models/on-bid-closed-request.d.ts +2 -2
- package/dist/models/on-bid-closed-request.js +2 -2
- package/dist/models/on-bid-failed-request.d.ts +2 -2
- package/dist/models/on-bid-failed-request.js +2 -2
- package/dist/models/on-ping-request.d.ts +2 -2
- package/dist/models/on-ping-request.js +2 -2
- package/dist/models/partner-webhook-delivery-status.d.ts +2 -2
- package/dist/models/partner-webhook-delivery-status.js +2 -2
- package/dist/models/partner-webhook-endpoint-status.d.ts +3 -3
- package/dist/models/partner-webhook-endpoint-status.js +3 -3
- package/dist/models/partner-webhook-event-type.d.ts +2 -2
- package/dist/models/partner-webhook-event-type.js +2 -2
- package/dist/models/payment-method-public.d.ts +2 -2
- package/dist/models/payment-method-public.js +2 -2
- package/dist/models/preconditions-dto.d.ts +2 -2
- package/dist/models/preconditions-dto.js +2 -2
- package/dist/models/problem-details-dto.d.ts +3 -3
- package/dist/models/problem-details-dto.js +2 -2
- package/dist/models/product-receipt-response-dto.d.ts +2 -2
- package/dist/models/product-receipt-response-dto.js +2 -2
- package/dist/models/product-response-dto.d.ts +3 -3
- package/dist/models/product-response-dto.js +2 -2
- package/dist/models/protected-resource-metadata-dto.d.ts +6 -6
- package/dist/models/protected-resource-metadata-dto.js +2 -2
- package/dist/models/register-award-request-dto.d.ts +5 -5
- package/dist/models/register-award-request-dto.js +2 -2
- package/dist/models/register-award201-response.d.ts +2 -2
- package/dist/models/register-award201-response.js +2 -2
- package/dist/models/register-bid201-response.d.ts +2 -2
- package/dist/models/register-bid201-response.js +2 -2
- package/dist/models/register-semo-contract-request-dto.d.ts +5 -5
- package/dist/models/register-semo-contract-request-dto.js +2 -2
- package/dist/models/request-invoice-split-request-dto.d.ts +4 -4
- package/dist/models/request-invoice-split-request-dto.js +2 -2
- package/dist/models/request-invoice-split200-response.d.ts +2 -2
- package/dist/models/request-invoice-split200-response.js +2 -2
- package/dist/models/retiree-roster-input-dto.d.ts +2 -2
- package/dist/models/retiree-roster-input-dto.js +2 -2
- package/dist/models/retiree-roster-row-dto.d.ts +2 -2
- package/dist/models/retiree-roster-row-dto.js +2 -2
- package/dist/models/revert-award-request-dto.d.ts +2 -2
- package/dist/models/revert-award-request-dto.js +2 -2
- package/dist/models/revert-award200-response.d.ts +2 -2
- package/dist/models/revert-award200-response.js +2 -2
- package/dist/models/revoke-request-dto.d.ts +5 -5
- package/dist/models/revoke-request-dto.js +2 -2
- package/dist/models/semo-contract-registered-response-dto.d.ts +3 -3
- package/dist/models/semo-contract-registered-response-dto.js +2 -2
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +2 -2
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +2 -2
- package/dist/models/send-webhook-test-event200-response.d.ts +2 -2
- package/dist/models/send-webhook-test-event200-response.js +2 -2
- package/dist/models/statement-document-dto.d.ts +3 -3
- package/dist/models/statement-document-dto.js +2 -2
- package/dist/models/statement-product-dto.d.ts +2 -2
- package/dist/models/statement-product-dto.js +2 -2
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +2 -2
- package/dist/models/submit-negotiation-scores-request-dto.js +2 -2
- package/dist/models/submit-negotiation-scores201-response.d.ts +2 -2
- package/dist/models/submit-negotiation-scores201-response.js +2 -2
- package/dist/models/supplier-card-payable-response-dto.d.ts +2 -2
- package/dist/models/supplier-card-payable-response-dto.js +2 -2
- package/dist/models/supplier-tax-type.d.ts +2 -2
- package/dist/models/supplier-tax-type.js +2 -2
- package/dist/models/token-request-dto.d.ts +5 -5
- package/dist/models/token-request-dto.js +2 -2
- package/dist/models/token-response-dto.d.ts +3 -3
- package/dist/models/token-response-dto.js +2 -2
- package/dist/models/update-bid-request-dto.d.ts +5 -5
- package/dist/models/update-bid-request-dto.js +2 -2
- package/dist/models/update-bid200-response.d.ts +2 -2
- package/dist/models/update-bid200-response.js +2 -2
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +3 -3
- package/dist/models/update-webhook-endpoint-request-dto.js +2 -2
- package/dist/models/upload-file-request-dto.d.ts +4 -4
- package/dist/models/upload-file-request-dto.js +2 -2
- package/dist/models/upload-file201-response.d.ts +2 -2
- package/dist/models/upload-file201-response.js +2 -2
- package/dist/models/upload-url-created-response-dto.d.ts +5 -5
- package/dist/models/upload-url-created-response-dto.js +2 -2
- package/dist/models/webhook-bid-event-data.d.ts +3 -3
- package/dist/models/webhook-bid-event-data.js +2 -2
- package/dist/models/webhook-delivery-dto.d.ts +4 -4
- package/dist/models/webhook-delivery-dto.js +2 -2
- package/dist/models/webhook-endpoint-dto.d.ts +6 -6
- package/dist/models/webhook-endpoint-dto.js +2 -2
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +6 -6
- package/dist/models/webhook-endpoint-with-secret-dto.js +2 -2
- package/dist/models/webhook-event-envelope.d.ts +3 -3
- package/dist/models/webhook-event-envelope.js +2 -2
- package/dist/models/webhook-ping-event-data.d.ts +2 -2
- package/dist/models/webhook-ping-event-data.js +2 -2
- package/dist/models/webhook-test-result-dto.d.ts +3 -3
- package/dist/models/webhook-test-result-dto.js +2 -2
- package/docs/AcknowledgeProductsRequestDto.md +1 -1
- package/docs/ApiCatalogEntryDto.md +2 -2
- package/docs/AuthorizationServerMetadataDto.md +4 -4
- package/docs/AwardRegisteredV2ResponseDto.md +1 -1
- package/docs/AwardRevertedV2ResponseDto.md +1 -1
- package/docs/BidAttachmentInputDto.md +4 -4
- package/docs/BidCancelledResponseDto.md +1 -1
- package/docs/BidContractDocumentDto.md +7 -7
- package/docs/BidDetailResponseDto.md +3 -3
- package/docs/BidFailedV2ResponseDto.md +1 -1
- package/docs/BidRegisteredResponseDto.md +1 -1
- package/docs/BidResultParticipantAttachmentDto.md +1 -1
- package/docs/BidResultParticipantDto.md +1 -1
- package/docs/BidResultsResponseDto.md +3 -3
- package/docs/BidSummaryDto.md +1 -1
- package/docs/CompleteAcceptanceRequestDto.md +2 -2
- package/docs/ContractRestrictionConfirmInputDto.md +1 -1
- package/docs/CreateBidRequestDto.md +3 -3
- package/docs/CreateExternalContractDocumentsRequestDto.md +2 -2
- package/docs/CreateWebhookEndpointRequestDto.md +2 -2
- package/docs/EmbedApi.md +11 -11
- package/docs/EmbedBidPrefillDto.md +46 -0
- package/docs/EmbedBidPrefillItemDto.md +28 -0
- package/docs/EmbedBidPrefillManagerDto.md +24 -0
- package/docs/EmbedLaunchRequestDto.md +6 -6
- package/docs/EmbedLaunchResponseDto.md +2 -2
- package/docs/ExternalContractDocumentItemDto.md +1 -1
- package/docs/ExternalContractSnapshotDto.md +3 -3
- package/docs/GeneratedExternalContractDocumentDto.md +2 -2
- package/docs/IntrospectRequestDto.md +3 -3
- package/docs/IntrospectionResponseDto.md +2 -2
- package/docs/ListBids200ResponseMeta.md +1 -1
- package/docs/ListWebhookDeliveriesResponseDto.md +1 -1
- package/docs/NegotiationScoredV2ResponseDto.md +1 -1
- package/docs/OauthApi.md +7 -7
- package/docs/PartnerApiApi.md +467 -467
- package/docs/PartnerWebhookEndpointStatus.md +1 -1
- package/docs/ProblemDetailsDto.md +1 -1
- package/docs/ProductResponseDto.md +1 -1
- package/docs/ProductsApi.md +28 -28
- package/docs/ProtectedResourceMetadataDto.md +4 -4
- package/docs/RegisterAwardRequestDto.md +3 -3
- package/docs/RegisterSemoContractRequestDto.md +3 -3
- package/docs/RequestInvoiceSplitRequestDto.md +2 -2
- package/docs/RevokeRequestDto.md +3 -3
- package/docs/SemoContractRegisteredResponseDto.md +1 -1
- package/docs/StatementDocumentDto.md +1 -1
- package/docs/TokenRequestDto.md +3 -3
- package/docs/TokenResponseDto.md +1 -1
- package/docs/UpdateBidRequestDto.md +3 -3
- package/docs/UpdateWebhookEndpointRequestDto.md +1 -1
- package/docs/UploadFileRequestDto.md +2 -2
- package/docs/UploadUrlCreatedResponseDto.md +3 -3
- package/docs/WebhookBidEventData.md +1 -1
- package/docs/WebhookDeliveryDto.md +2 -2
- package/docs/WebhookEndpointDto.md +4 -4
- package/docs/WebhookEndpointWithSecretDto.md +4 -4
- package/docs/WebhookEventEnvelope.md +1 -1
- package/docs/WebhookTestResultDto.md +1 -1
- package/docs/WebhooksApi.md +43 -43
- package/docs/WellKnownApi.md +5 -5
- package/index.ts +2 -2
- package/models/acceptance-result-response-dto.ts +2 -2
- package/models/acknowledge-product-receipt200-response.ts +2 -2
- package/models/acknowledge-products-request-dto.ts +3 -3
- package/models/api-catalog-dto.ts +2 -2
- package/models/api-catalog-entry-dto.ts +4 -4
- package/models/api-catalog-link-dto.ts +2 -2
- package/models/authorization-server-metadata-dto.ts +6 -6
- package/models/award-method-public.ts +2 -2
- package/models/award-registered-v2-response-dto.ts +3 -3
- package/models/award-reverted-v2-response-dto.ts +3 -3
- package/models/bid-acceptance-dto.ts +2 -2
- package/models/bid-attachment-input-dto.ts +6 -6
- package/models/bid-bond-dto.ts +2 -2
- package/models/bid-cancelled-response-dto.ts +3 -3
- package/models/bid-contact-dto.ts +2 -2
- package/models/bid-contacts-dto.ts +2 -2
- package/models/bid-contract-document-dto.ts +9 -9
- package/models/bid-delivery-terms-dto.ts +2 -2
- package/models/bid-detail-response-dto.ts +5 -5
- package/models/bid-document-dto.ts +2 -2
- package/models/bid-failed-v2-response-dto.ts +3 -3
- package/models/bid-item-dto.ts +2 -2
- package/models/bid-lifecycle-dto.ts +2 -2
- package/models/bid-manager-dto.ts +2 -2
- package/models/bid-payment-terms-dto.ts +2 -2
- package/models/bid-product-dto.ts +2 -2
- package/models/bid-public-status.ts +2 -2
- package/models/bid-registered-response-dto.ts +3 -3
- package/models/bid-result-participant-attachment-dto.ts +3 -3
- package/models/bid-result-participant-dto.ts +3 -3
- package/models/bid-results-response-dto.ts +5 -5
- package/models/bid-settlement-line-item-dto.ts +2 -2
- package/models/bid-settlement-participant-dto.ts +2 -2
- package/models/bid-settlement-response-dto.ts +2 -2
- package/models/bid-statement-response-dto.ts +2 -2
- package/models/bid-summary-dto.ts +3 -3
- package/models/bid-type-public.ts +2 -2
- package/models/bid-updated-response-dto.ts +2 -2
- package/models/cancel-bid-request-dto.ts +2 -2
- package/models/cancel-bid200-response.ts +2 -2
- package/models/card-payment-request-response-dto.ts +2 -2
- package/models/complete-acceptance-request-dto.ts +4 -4
- package/models/complete-acceptance200-response.ts +2 -2
- package/models/complete-invoice200-response.ts +2 -2
- package/models/complete-upload-request-dto.ts +2 -2
- package/models/contract-restriction-confirm-input-dto.ts +3 -3
- package/models/create-bid-request-dto.ts +5 -5
- package/models/create-card-payment-dto.ts +2 -2
- package/models/create-card-payment-request-dto.ts +2 -2
- package/models/create-card-payment200-response.ts +2 -2
- package/models/create-embed-launch201-response.ts +2 -2
- package/models/create-external-contract-documents-request-dto.ts +4 -4
- package/models/create-external-contract-documents-response-dto.ts +2 -2
- package/models/create-file-upload-url201-response.ts +2 -2
- package/models/create-upload-url-request-dto.ts +2 -2
- package/models/create-webhook-endpoint-request-dto.ts +4 -4
- package/models/create-webhook-endpoint201-response.ts +2 -2
- package/models/delivery-date-type-public.ts +2 -2
- package/models/delivery-method-public.ts +2 -2
- package/models/embed-bid-prefill-dto.ts +97 -0
- package/models/embed-bid-prefill-item-dto.ts +39 -0
- package/models/embed-bid-prefill-manager-dto.ts +31 -0
- package/models/embed-launch-request-dto.ts +12 -9
- package/models/embed-launch-response-dto.ts +4 -4
- package/models/excellent-procurement-public.ts +2 -2
- package/models/external-contract-document-item-dto.ts +3 -3
- package/models/external-contract-documents-response-dto.ts +2 -2
- package/models/external-contract-item-dto.ts +2 -2
- package/models/external-contract-snapshot-dto.ts +5 -5
- package/models/external-document-inputs-dto.ts +2 -2
- package/models/file-meta-response-dto.ts +2 -2
- package/models/file-uploaded-response-dto.ts +2 -2
- package/models/generated-external-contract-document-dto.ts +4 -4
- package/models/get-bid-settlement200-response.ts +2 -2
- package/models/get-bid-statement200-response.ts +2 -2
- package/models/get-bid200-response.ts +2 -2
- package/models/get-file-meta200-response.ts +2 -2
- package/models/get-supplier-card-payable-v2200-response.ts +2 -2
- package/models/get-webhook-endpoint200-response.ts +2 -2
- package/models/green-product-public.ts +2 -2
- package/models/health-controller-check200-response.ts +2 -2
- package/models/health-response-dto.ts +2 -2
- package/models/hierarchical-region-dto.ts +2 -2
- package/models/index.ts +3 -0
- package/models/introspect-request-dto.ts +5 -5
- package/models/introspection-response-dto.ts +4 -4
- package/models/invalid-param-dto.ts +2 -2
- package/models/invoice-completed-response-dto.ts +2 -2
- package/models/invoice-split-response-dto.ts +2 -2
- package/models/legal-mandatory-public.ts +2 -2
- package/models/list-bid-results200-response.ts +2 -2
- package/models/list-bids200-response-meta.ts +3 -3
- package/models/list-bids200-response.ts +2 -2
- package/models/list-products200-response.ts +2 -2
- package/models/list-webhook-deliveries-response-dto.ts +3 -3
- package/models/list-webhook-deliveries200-response.ts +2 -2
- package/models/list-webhook-endpoints200-response.ts +2 -2
- package/models/mark-bid-failed-request-dto.ts +2 -2
- package/models/mark-bid-failed201-response.ts +2 -2
- package/models/negotiation-score-dto.ts +2 -2
- package/models/negotiation-scored-v2-response-dto.ts +3 -3
- package/models/oauth-error-response-dto.ts +2 -2
- package/models/on-bid-award-reverted-request.ts +2 -2
- package/models/on-bid-awarded-request.ts +2 -2
- package/models/on-bid-canceled-request.ts +2 -2
- package/models/on-bid-closed-request.ts +2 -2
- package/models/on-bid-failed-request.ts +2 -2
- package/models/on-ping-request.ts +2 -2
- package/models/partner-webhook-delivery-status.ts +2 -2
- package/models/partner-webhook-endpoint-status.ts +3 -3
- package/models/partner-webhook-event-type.ts +2 -2
- package/models/payment-method-public.ts +2 -2
- package/models/preconditions-dto.ts +2 -2
- package/models/problem-details-dto.ts +3 -3
- package/models/product-receipt-response-dto.ts +2 -2
- package/models/product-response-dto.ts +3 -3
- package/models/protected-resource-metadata-dto.ts +6 -6
- package/models/register-award-request-dto.ts +5 -5
- package/models/register-award201-response.ts +2 -2
- package/models/register-bid201-response.ts +2 -2
- package/models/register-semo-contract-request-dto.ts +5 -5
- package/models/request-invoice-split-request-dto.ts +4 -4
- package/models/request-invoice-split200-response.ts +2 -2
- package/models/retiree-roster-input-dto.ts +2 -2
- package/models/retiree-roster-row-dto.ts +2 -2
- package/models/revert-award-request-dto.ts +2 -2
- package/models/revert-award200-response.ts +2 -2
- package/models/revoke-request-dto.ts +5 -5
- package/models/semo-contract-registered-response-dto.ts +3 -3
- package/models/semo-contract-taxinvoice-status-response-dto.ts +2 -2
- package/models/send-webhook-test-event200-response.ts +2 -2
- package/models/statement-document-dto.ts +3 -3
- package/models/statement-product-dto.ts +2 -2
- package/models/submit-negotiation-scores-request-dto.ts +2 -2
- package/models/submit-negotiation-scores201-response.ts +2 -2
- package/models/supplier-card-payable-response-dto.ts +2 -2
- package/models/supplier-tax-type.ts +2 -2
- package/models/token-request-dto.ts +5 -5
- package/models/token-response-dto.ts +3 -3
- package/models/update-bid-request-dto.ts +5 -5
- package/models/update-bid200-response.ts +2 -2
- package/models/update-webhook-endpoint-request-dto.ts +3 -3
- package/models/upload-file-request-dto.ts +4 -4
- package/models/upload-file201-response.ts +2 -2
- package/models/upload-url-created-response-dto.ts +5 -5
- package/models/webhook-bid-event-data.ts +3 -3
- package/models/webhook-delivery-dto.ts +4 -4
- package/models/webhook-endpoint-dto.ts +6 -6
- package/models/webhook-endpoint-with-secret-dto.ts +6 -6
- package/models/webhook-event-envelope.ts +3 -3
- package/models/webhook-ping-event-data.ts +2 -2
- package/models/webhook-test-result-dto.ts +3 -3
- package/package.json +1 -1
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
export interface AuthorizationServerMetadataDto {
|
|
18
18
|
/**
|
|
19
|
-
* μ΄ authorization server
|
|
19
|
+
* μ΄ authorization serverμ issuer identifier. λ°κΈ ν ν°μ `iss`μ κ°μ κ°μ΄λ©°, ν΄λΌμ΄μΈνΈλ μ΄ κ°μΌλ‘ λ³Έ λ¬Έμμ URLμ λ§λ€μ΄ λμ‘°νλ€(RFC 8414 Β§3.3).
|
|
20
20
|
*/
|
|
21
21
|
'issuer': string;
|
|
22
22
|
/**
|
|
@@ -32,11 +32,11 @@ export interface AuthorizationServerMetadataDto {
|
|
|
32
32
|
*/
|
|
33
33
|
'introspection_endpoint': string;
|
|
34
34
|
/**
|
|
35
|
-
* μ§μ grant type. μ΄ AS
|
|
35
|
+
* μ§μ grant type. μ΄ ASλ μλ²-ν¬-μλ² μ°λλ§ λ€λ£¨λ―λ‘ client_credentials λΏμ΄λ€.
|
|
36
36
|
*/
|
|
37
37
|
'grant_types_supported': Array<string>;
|
|
38
38
|
/**
|
|
39
|
-
* token endpoint
|
|
39
|
+
* token endpointμ client μΈμ¦ λ°©μ (RFC 6749 Β§2.3.1).
|
|
40
40
|
*/
|
|
41
41
|
'token_endpoint_auth_methods_supported': Array<string>;
|
|
42
42
|
/**
|
|
@@ -48,7 +48,7 @@ export interface AuthorizationServerMetadataDto {
|
|
|
48
48
|
*/
|
|
49
49
|
'scopes_supported': Array<string>;
|
|
50
50
|
/**
|
|
51
|
-
* RFC 8414 Β§2 νμ νλ. authorization endpoint
|
|
51
|
+
* RFC 8414 Β§2 νμ νλ. authorization endpointλ₯Ό μ°λ νλ¦μ΄ μμΌλ―λ‘ νμ λΉ λ°°μ΄μ΄λ€.
|
|
52
52
|
*/
|
|
53
53
|
'response_types_supported': Array<string>;
|
|
54
54
|
/**
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
export interface AwardRegisteredV2ResponseDto {
|
|
18
18
|
/**
|
|
19
|
-
* κ³΅κ³ IDμ
λλ€(μμ²ν bidId
|
|
19
|
+
* κ³΅κ³ IDμ
λλ€(μμ²ν bidIdλ₯Ό κ·Έλλ‘ λλ €μ€λλ€).
|
|
20
20
|
*/
|
|
21
21
|
'bidId': string;
|
|
22
22
|
/**
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
export interface AwardRevertedV2ResponseDto {
|
|
18
18
|
/**
|
|
19
|
-
* κ³΅κ³ IDμ
λλ€(μμ²ν bidId
|
|
19
|
+
* κ³΅κ³ IDμ
λλ€(μμ²ν bidIdλ₯Ό κ·Έλλ‘ λλ €μ€λλ€).
|
|
20
20
|
*/
|
|
21
21
|
'bidId': string;
|
|
22
22
|
/**
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -16,19 +16,19 @@
|
|
|
16
16
|
|
|
17
17
|
export interface BidAttachmentInputDto {
|
|
18
18
|
/**
|
|
19
|
-
* μ΄λ―Έ μ
λ‘λν νμΌμ ν€(μλ¬Έ λμλ¬ΈμΒ·μ«μ 32μ). `POST /v2/files` λλ `POST /v2/files/{fileKey}/complete` μλ΅μμ λ°μ΅λλ€. `url`Β·`base64
|
|
19
|
+
* μ΄λ―Έ μ
λ‘λν νμΌμ ν€(μλ¬Έ λμλ¬ΈμΒ·μ«μ 32μ). `POST /v2/files` λλ `POST /v2/files/{fileKey}/complete` μλ΅μμ λ°μ΅λλ€. `url`Β·`base64`μ ν¨κ» λ³΄λΌ μ μμ΅λλ€.
|
|
20
20
|
*/
|
|
21
21
|
'fileKey'?: string;
|
|
22
22
|
/**
|
|
23
|
-
* νμΌλͺ
(νμ₯μ ν¬ν¨). `base64
|
|
23
|
+
* νμΌλͺ
(νμ₯μ ν¬ν¨). `base64`λ₯Ό λ³΄λΌ λλ νμμ
λλ€ β νμ₯μλ₯Ό μ§μ΄λ΄μ§ μκΈ° λλ¬Έμ
λλ€. `url` μΌ λλ μλ΅νλ©΄ μ£Όμμμ μ μΆν©λλ€.
|
|
24
24
|
*/
|
|
25
25
|
'fileName'?: string;
|
|
26
26
|
/**
|
|
27
|
-
* λ΄λ €λ°μ μ μλ https μ£Όμ. c-market
|
|
27
|
+
* λ΄λ €λ°μ μ μλ https μ£Όμ. c-marketμ΄ μλ²μμ μ§μ λ°μ μ μ₯ν©λλ€ β λ³Έλ¬Έμ λ°μ΄νΈλ₯Ό μ£μ§ μμΌλ―λ‘ ν¬κΈ° μ μ½μ΄ κ°μ₯ λμ¨ν©λλ€.
|
|
28
28
|
*/
|
|
29
29
|
'url'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* Base64 μΈμ½λ©λ νμΌ λ°μ΄ν°. λμ½λ© ν μ΄ μμ² μ 체 ν©κ³ μ΅λ 23MB. λ ν¬λ©΄ `POST /v2/files/upload-url
|
|
31
|
+
* Base64 μΈμ½λ©λ νμΌ λ°μ΄ν°. λμ½λ© ν μ΄ μμ² μ 체 ν©κ³ μ΅λ 23MB. λ ν¬λ©΄ `POST /v2/files/upload-url`λ‘ μ¬λ¦¬κ³ `fileKey`λ‘ μ°Έμ‘°νμΈμ.
|
|
32
32
|
*/
|
|
33
33
|
'base64'?: string;
|
|
34
34
|
}
|
package/models/bid-bond-dto.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
export interface BidCancelledResponseDto {
|
|
18
18
|
/**
|
|
19
|
-
* κ³΅κ³ μλ³μμ
λλ€(μμ²ν bidId
|
|
19
|
+
* κ³΅κ³ μλ³μμ
λλ€(μμ²ν bidIdλ₯Ό κ·Έλλ‘ λλ €μ€λλ€).
|
|
20
20
|
*/
|
|
21
21
|
'bidId': string;
|
|
22
22
|
/**
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
|
-
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token
|
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 40.0.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).
|
|
@@ -24,19 +24,19 @@ export interface BidContractDocumentDto {
|
|
|
24
24
|
*/
|
|
25
25
|
'paperName': string;
|
|
26
26
|
/**
|
|
27
|
-
* νμΌ ν€. μμ§ μ μΆΒ·μμ±λμ§ μμ μλ₯λ null
|
|
27
|
+
* νμΌ ν€. μμ§ μ μΆΒ·μμ±λμ§ μμ μλ₯λ nullμ
λλ€. `GET /files/{fileKey}`λ‘ λ΄λ €λ°μ μ μμ΅λλ€.
|
|
28
28
|
*/
|
|
29
29
|
'fileKey': string | null;
|
|
30
30
|
/**
|
|
31
|
-
* νμΌλͺ
. λ―Έμ μΆΒ·λ―Έμμ± μλ₯λ null
|
|
31
|
+
* νμΌλͺ
. λ―Έμ μΆΒ·λ―Έμμ± μλ₯λ nullμ
λλ€.
|
|
32
32
|
*/
|
|
33
33
|
'fileName': string | null;
|
|
34
34
|
/**
|
|
35
|
-
* μ¦μ λ΄λ €λ°κΈ°μ© μλͺ
URL
|
|
35
|
+
* μ¦μ λ΄λ €λ°κΈ°μ© μλͺ
URLμ
λλ€. μ ν¨κΈ°κ°μ΄ 1μκ°μ΄λ―λ‘ μ μ₯νμ§ λ§μκ³ λ§€λ² λ€μ μ‘°ννμΈμ. νμΌμ΄ μμ§ μμΌλ©΄ μλ΅λ©λλ€.
|
|
36
36
|
*/
|
|
37
37
|
'downloadUrl'?: string;
|
|
38
38
|
/**
|
|
39
|
-
* νμΌ λ±λ‘ μΌμ(RFC 3339 UTC). λ―Έμ μΆ μλ₯λ null
|
|
39
|
+
* νμΌ λ±λ‘ μΌμ(RFC 3339 UTC). λ―Έμ μΆ μλ₯λ nullμ
λλ€.
|
|
40
40
|
*/
|
|
41
41
|
'uploadedAt': string | null;
|
|
42
42
|
/**
|
|
@@ -44,15 +44,15 @@ export interface BidContractDocumentDto {
|
|
|
44
44
|
*/
|
|
45
45
|
'source': string;
|
|
46
46
|
/**
|
|
47
|
-
* c-market
|
|
47
|
+
* c-marketμ΄ μλμΌλ‘ λ§λ€μ΄ μ£Όλ μλ₯μΈμ§ μ¬λΆμ
λλ€.
|
|
48
48
|
*/
|
|
49
49
|
'autoGenerated': boolean;
|
|
50
50
|
/**
|
|
51
|
-
* μλμμ± μλ₯μ μμ± μ§ν μνμ
λλ€. μλμμ± λμμ΄ μλλ©΄ null
|
|
51
|
+
* μλμμ± μλ₯μ μμ± μ§ν μνμ
λλ€. μλμμ± λμμ΄ μλλ©΄ nullμ
λλ€. DEAD_LETTERλ μμ±μ΄ μ€ν¨ν΄ λ©μΆ μνμ΄λ©° μ¬μμ± μμ²μΌλ‘ λμ΄λ¦½λλ€.
|
|
52
52
|
*/
|
|
53
53
|
'generationState': BidContractDocumentDtoGenerationStateEnum | null;
|
|
54
54
|
/**
|
|
55
|
-
* μ΄ μλ₯κ° κ·μλ λμ°°μμ μμ°° μλ²(participants[].sequence)μ
λλ€. κ³΅κ³ μ 체μ 곡ν΅μΈ μλ₯λ null
|
|
55
|
+
* μ΄ μλ₯κ° κ·μλ λμ°°μμ μμ°° μλ²(participants[].sequence)μ
λλ€. κ³΅κ³ μ 체μ 곡ν΅μΈ μλ₯λ nullμ
λλ€.
|
|
56
56
|
*/
|
|
57
57
|
'winnerSequence': number | null;
|
|
58
58
|
}
|