@cmarket/partner-sdk 38.0.0 โ 38.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -5
- package/api/embed-api.ts +9 -9
- package/api/oauth-api.ts +1 -1
- package/api/partner-api-api.ts +683 -1
- package/api/products-api.ts +1 -1
- package/api/well-known-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/embed-api.d.ts +9 -9
- package/dist/api/embed-api.js +9 -9
- package/dist/api/oauth-api.d.ts +1 -1
- package/dist/api/oauth-api.js +1 -1
- package/dist/api/partner-api-api.d.ts +305 -1
- package/dist/api/partner-api-api.js +639 -1
- package/dist/api/products-api.d.ts +1 -1
- package/dist/api/products-api.js +1 -1
- package/dist/api/well-known-api.d.ts +1 -1
- package/dist/api/well-known-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/embed-api.d.ts +9 -9
- package/dist/esm/api/embed-api.js +9 -9
- package/dist/esm/api/oauth-api.d.ts +1 -1
- package/dist/esm/api/oauth-api.js +1 -1
- package/dist/esm/api/partner-api-api.d.ts +305 -1
- package/dist/esm/api/partner-api-api.js +639 -1
- package/dist/esm/api/products-api.d.ts +1 -1
- package/dist/esm/api/products-api.js +1 -1
- package/dist/esm/api/well-known-api.d.ts +1 -1
- package/dist/esm/api/well-known-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/esm/models/acceptance-result-response-dto.js +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.js +1 -1
- package/dist/esm/models/api-catalog-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-dto.js +1 -1
- package/dist/esm/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-entry-dto.js +1 -1
- package/dist/esm/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-link-dto.js +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.js +1 -1
- package/dist/esm/models/award-method-public.d.ts +1 -1
- package/dist/esm/models/award-method-public.js +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.js +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/esm/models/bid-acceptance-dto.js +1 -1
- package/dist/esm/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/esm/models/bid-attachment-input-dto.js +1 -1
- package/dist/esm/models/bid-bond-dto.d.ts +1 -1
- package/dist/esm/models/bid-bond-dto.js +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.js +1 -1
- package/dist/esm/models/bid-contact-dto.d.ts +1 -1
- package/dist/esm/models/bid-contact-dto.js +1 -1
- package/dist/esm/models/bid-contacts-dto.d.ts +1 -1
- package/dist/esm/models/bid-contacts-dto.js +1 -1
- package/dist/esm/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-contract-document-dto.js +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.js +1 -1
- package/dist/esm/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-detail-response-dto.js +1 -1
- package/dist/esm/models/bid-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-document-dto.js +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-item-dto.js +1 -1
- package/dist/esm/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/esm/models/bid-lifecycle-dto.js +1 -1
- package/dist/esm/models/bid-manager-dto.d.ts +1 -1
- package/dist/esm/models/bid-manager-dto.js +1 -1
- package/dist/esm/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-payment-terms-dto.js +1 -1
- package/dist/esm/models/bid-product-dto.d.ts +1 -1
- package/dist/esm/models/bid-product-dto.js +1 -1
- package/dist/esm/models/bid-public-status.d.ts +1 -1
- package/dist/esm/models/bid-public-status.js +1 -1
- package/dist/esm/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-registered-response-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-dto.js +1 -1
- package/dist/esm/models/bid-results-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-results-response-dto.js +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.js +1 -1
- package/dist/esm/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-response-dto.js +1 -1
- package/dist/esm/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-statement-response-dto.js +1 -1
- package/dist/esm/models/bid-summary-dto.d.ts +1 -1
- package/dist/esm/models/bid-summary-dto.js +1 -1
- package/dist/esm/models/bid-type-public.d.ts +1 -1
- package/dist/esm/models/bid-type-public.js +1 -1
- package/dist/esm/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-updated-response-dto.js +1 -1
- package/dist/esm/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/cancel-bid-request-dto.js +1 -1
- package/dist/esm/models/cancel-bid200-response.d.ts +1 -1
- package/dist/esm/models/cancel-bid200-response.js +1 -1
- package/dist/esm/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/esm/models/card-payment-request-response-dto.js +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.js +1 -1
- package/dist/esm/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/esm/models/complete-acceptance200-response.js +1 -1
- package/dist/esm/models/complete-invoice200-response.d.ts +1 -1
- package/dist/esm/models/complete-invoice200-response.js +1 -1
- package/dist/esm/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-upload-request-dto.js +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/esm/models/create-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/create-bid-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-dto.js +1 -1
- package/dist/esm/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment200-response.d.ts +1 -1
- package/dist/esm/models/create-card-payment200-response.js +1 -1
- package/dist/esm/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/esm/models/create-embed-launch201-response.js +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/esm/models/create-file-upload-url201-response.js +1 -1
- package/dist/esm/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/esm/models/create-upload-url-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +22 -0
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +14 -0
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +15 -0
- package/dist/esm/models/create-webhook-endpoint201-response.js +14 -0
- package/dist/esm/models/delivery-date-type-public.d.ts +1 -1
- package/dist/esm/models/delivery-date-type-public.js +1 -1
- package/dist/esm/models/delivery-method-public.d.ts +1 -1
- package/dist/esm/models/delivery-method-public.js +1 -1
- package/dist/esm/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-request-dto.js +1 -1
- package/dist/esm/models/embed-launch-response-dto.d.ts +6 -2
- package/dist/esm/models/embed-launch-response-dto.js +1 -1
- package/dist/esm/models/excellent-procurement-public.d.ts +1 -1
- package/dist/esm/models/excellent-procurement-public.js +1 -1
- package/dist/esm/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-document-item-dto.js +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/external-contract-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-item-dto.js +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.js +1 -1
- package/dist/esm/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/esm/models/external-document-inputs-dto.js +1 -1
- package/dist/esm/models/file-meta-response-dto.d.ts +1 -1
- package/dist/esm/models/file-meta-response-dto.js +1 -1
- package/dist/esm/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/esm/models/file-uploaded-response-dto.js +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.js +1 -1
- package/dist/esm/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-settlement200-response.js +1 -1
- package/dist/esm/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-statement200-response.js +1 -1
- package/dist/esm/models/get-bid200-response.d.ts +1 -1
- package/dist/esm/models/get-bid200-response.js +1 -1
- package/dist/esm/models/get-file-meta200-response.d.ts +1 -1
- package/dist/esm/models/get-file-meta200-response.js +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +15 -0
- package/dist/esm/models/get-webhook-endpoint200-response.js +14 -0
- package/dist/esm/models/green-product-public.d.ts +1 -1
- package/dist/esm/models/green-product-public.js +1 -1
- package/dist/esm/models/health-controller-check200-response.d.ts +1 -1
- package/dist/esm/models/health-controller-check200-response.js +1 -1
- package/dist/esm/models/health-response-dto.d.ts +1 -1
- package/dist/esm/models/health-response-dto.js +1 -1
- package/dist/esm/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/esm/models/hierarchical-region-dto.js +1 -1
- package/dist/esm/models/index.d.ts +15 -0
- package/dist/esm/models/index.js +15 -0
- package/dist/esm/models/introspect-request-dto.d.ts +1 -1
- package/dist/esm/models/introspect-request-dto.js +1 -1
- package/dist/esm/models/introspection-response-dto.d.ts +1 -1
- package/dist/esm/models/introspection-response-dto.js +1 -1
- package/dist/esm/models/invalid-param-dto.d.ts +1 -1
- package/dist/esm/models/invalid-param-dto.js +1 -1
- package/dist/esm/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-completed-response-dto.js +1 -1
- package/dist/esm/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-split-response-dto.js +1 -1
- package/dist/esm/models/legal-mandatory-public.d.ts +1 -1
- package/dist/esm/models/legal-mandatory-public.js +1 -1
- package/dist/esm/models/list-bid-results200-response.d.ts +1 -1
- package/dist/esm/models/list-bid-results200-response.js +1 -1
- package/dist/esm/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/esm/models/list-bids200-response-meta.js +1 -1
- package/dist/esm/models/list-bids200-response.d.ts +1 -1
- package/dist/esm/models/list-bids200-response.js +1 -1
- package/dist/esm/models/list-products200-response.d.ts +1 -1
- package/dist/esm/models/list-products200-response.js +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +22 -0
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +14 -0
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +15 -0
- package/dist/esm/models/list-webhook-deliveries200-response.js +14 -0
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +17 -0
- package/dist/esm/models/list-webhook-endpoints200-response.js +14 -0
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/esm/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed201-response.js +1 -1
- package/dist/esm/models/negotiation-score-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-score-dto.js +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/esm/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/esm/models/oauth-error-response-dto.js +1 -1
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +18 -0
- package/dist/esm/models/partner-webhook-delivery-status.js +19 -0
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +19 -0
- package/dist/esm/models/partner-webhook-endpoint-status.js +20 -0
- package/dist/esm/models/partner-webhook-event-type.d.ts +22 -0
- package/dist/esm/models/partner-webhook-event-type.js +23 -0
- package/dist/esm/models/payment-method-public.d.ts +1 -1
- package/dist/esm/models/payment-method-public.js +1 -1
- package/dist/esm/models/preconditions-dto.d.ts +1 -1
- package/dist/esm/models/preconditions-dto.js +1 -1
- package/dist/esm/models/problem-details-dto.d.ts +1 -1
- package/dist/esm/models/problem-details-dto.js +1 -1
- package/dist/esm/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/esm/models/product-receipt-response-dto.js +1 -1
- package/dist/esm/models/product-response-dto.d.ts +1 -1
- package/dist/esm/models/product-response-dto.js +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.js +1 -1
- package/dist/esm/models/register-award-request-dto.d.ts +1 -1
- package/dist/esm/models/register-award-request-dto.js +1 -1
- package/dist/esm/models/register-award201-response.d.ts +1 -1
- package/dist/esm/models/register-award201-response.js +1 -1
- package/dist/esm/models/register-bid201-response.d.ts +1 -1
- package/dist/esm/models/register-bid201-response.js +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/esm/models/request-invoice-split200-response.js +1 -1
- package/dist/esm/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-input-dto.js +1 -1
- package/dist/esm/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-row-dto.js +1 -1
- package/dist/esm/models/revert-award-request-dto.d.ts +1 -1
- package/dist/esm/models/revert-award-request-dto.js +1 -1
- package/dist/esm/models/revert-award200-response.d.ts +1 -1
- package/dist/esm/models/revert-award200-response.js +1 -1
- package/dist/esm/models/revoke-request-dto.d.ts +1 -1
- package/dist/esm/models/revoke-request-dto.js +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +15 -0
- package/dist/esm/models/send-webhook-test-event200-response.js +14 -0
- package/dist/esm/models/statement-document-dto.d.ts +1 -1
- package/dist/esm/models/statement-document-dto.js +1 -1
- package/dist/esm/models/statement-product-dto.d.ts +1 -1
- package/dist/esm/models/statement-product-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/esm/models/supplier-tax-type.d.ts +1 -1
- package/dist/esm/models/supplier-tax-type.js +1 -1
- package/dist/esm/models/token-request-dto.d.ts +1 -1
- package/dist/esm/models/token-request-dto.js +1 -1
- package/dist/esm/models/token-response-dto.d.ts +1 -1
- package/dist/esm/models/token-response-dto.js +1 -1
- package/dist/esm/models/update-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/update-bid-request-dto.js +1 -1
- package/dist/esm/models/update-bid200-response.d.ts +1 -1
- package/dist/esm/models/update-bid200-response.js +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +27 -0
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +14 -0
- package/dist/esm/models/upload-file-request-dto.d.ts +1 -1
- package/dist/esm/models/upload-file-request-dto.js +1 -1
- package/dist/esm/models/upload-file201-response.d.ts +1 -1
- package/dist/esm/models/upload-file201-response.js +1 -1
- package/dist/esm/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/esm/models/upload-url-created-response-dto.js +1 -1
- package/dist/esm/models/webhook-delivery-dto.d.ts +73 -0
- package/dist/esm/models/webhook-delivery-dto.js +21 -0
- package/dist/esm/models/webhook-endpoint-dto.d.ts +55 -0
- package/dist/esm/models/webhook-endpoint-dto.js +14 -0
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +59 -0
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +14 -0
- package/dist/esm/models/webhook-test-result-dto.d.ts +25 -0
- package/dist/esm/models/webhook-test-result-dto.js +14 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/models/acceptance-result-response-dto.js +1 -1
- package/dist/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/models/acknowledge-products-request-dto.js +1 -1
- package/dist/models/api-catalog-dto.d.ts +1 -1
- package/dist/models/api-catalog-dto.js +1 -1
- package/dist/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/models/api-catalog-entry-dto.js +1 -1
- package/dist/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/models/api-catalog-link-dto.js +1 -1
- package/dist/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/models/authorization-server-metadata-dto.js +1 -1
- package/dist/models/award-method-public.d.ts +1 -1
- package/dist/models/award-method-public.js +1 -1
- package/dist/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/models/award-registered-v2-response-dto.js +1 -1
- package/dist/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/models/bid-acceptance-dto.js +1 -1
- package/dist/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/models/bid-attachment-input-dto.js +1 -1
- package/dist/models/bid-bond-dto.d.ts +1 -1
- package/dist/models/bid-bond-dto.js +1 -1
- package/dist/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/models/bid-cancelled-response-dto.js +1 -1
- package/dist/models/bid-contact-dto.d.ts +1 -1
- package/dist/models/bid-contact-dto.js +1 -1
- package/dist/models/bid-contacts-dto.d.ts +1 -1
- package/dist/models/bid-contacts-dto.js +1 -1
- package/dist/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/models/bid-contract-document-dto.js +1 -1
- package/dist/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/models/bid-delivery-terms-dto.js +1 -1
- package/dist/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/models/bid-detail-response-dto.js +1 -1
- package/dist/models/bid-document-dto.d.ts +1 -1
- package/dist/models/bid-document-dto.js +1 -1
- package/dist/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/models/bid-item-dto.d.ts +1 -1
- package/dist/models/bid-item-dto.js +1 -1
- package/dist/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/models/bid-lifecycle-dto.js +1 -1
- package/dist/models/bid-manager-dto.d.ts +1 -1
- package/dist/models/bid-manager-dto.js +1 -1
- package/dist/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/models/bid-payment-terms-dto.js +1 -1
- package/dist/models/bid-product-dto.d.ts +1 -1
- package/dist/models/bid-product-dto.js +1 -1
- package/dist/models/bid-public-status.d.ts +1 -1
- package/dist/models/bid-public-status.js +1 -1
- package/dist/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/models/bid-registered-response-dto.js +1 -1
- package/dist/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-dto.js +1 -1
- package/dist/models/bid-results-response-dto.d.ts +1 -1
- package/dist/models/bid-results-response-dto.js +1 -1
- package/dist/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/models/bid-settlement-participant-dto.js +1 -1
- package/dist/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/models/bid-settlement-response-dto.js +1 -1
- package/dist/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/models/bid-statement-response-dto.js +1 -1
- package/dist/models/bid-summary-dto.d.ts +1 -1
- package/dist/models/bid-summary-dto.js +1 -1
- package/dist/models/bid-type-public.d.ts +1 -1
- package/dist/models/bid-type-public.js +1 -1
- package/dist/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/models/bid-updated-response-dto.js +1 -1
- package/dist/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/models/cancel-bid-request-dto.js +1 -1
- package/dist/models/cancel-bid200-response.d.ts +1 -1
- package/dist/models/cancel-bid200-response.js +1 -1
- package/dist/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/models/card-payment-request-response-dto.js +1 -1
- package/dist/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/models/complete-acceptance-request-dto.js +1 -1
- package/dist/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/models/complete-acceptance200-response.js +1 -1
- package/dist/models/complete-invoice200-response.d.ts +1 -1
- package/dist/models/complete-invoice200-response.js +1 -1
- package/dist/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/models/complete-upload-request-dto.js +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/models/create-bid-request-dto.d.ts +1 -1
- package/dist/models/create-bid-request-dto.js +1 -1
- package/dist/models/create-card-payment-dto.d.ts +1 -1
- package/dist/models/create-card-payment-dto.js +1 -1
- package/dist/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/models/create-card-payment-request-dto.js +1 -1
- package/dist/models/create-card-payment200-response.d.ts +1 -1
- package/dist/models/create-card-payment200-response.js +1 -1
- package/dist/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/models/create-embed-launch201-response.js +1 -1
- package/dist/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/models/create-file-upload-url201-response.js +1 -1
- package/dist/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/models/create-upload-url-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +22 -0
- package/dist/models/create-webhook-endpoint-request-dto.js +15 -0
- package/dist/models/create-webhook-endpoint201-response.d.ts +15 -0
- package/dist/models/create-webhook-endpoint201-response.js +15 -0
- package/dist/models/delivery-date-type-public.d.ts +1 -1
- package/dist/models/delivery-date-type-public.js +1 -1
- package/dist/models/delivery-method-public.d.ts +1 -1
- package/dist/models/delivery-method-public.js +1 -1
- package/dist/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/models/embed-launch-request-dto.js +1 -1
- package/dist/models/embed-launch-response-dto.d.ts +6 -2
- package/dist/models/embed-launch-response-dto.js +1 -1
- package/dist/models/excellent-procurement-public.d.ts +1 -1
- package/dist/models/excellent-procurement-public.js +1 -1
- package/dist/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/models/external-contract-document-item-dto.js +1 -1
- package/dist/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/external-contract-documents-response-dto.js +1 -1
- package/dist/models/external-contract-item-dto.d.ts +1 -1
- package/dist/models/external-contract-item-dto.js +1 -1
- package/dist/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/models/external-contract-snapshot-dto.js +1 -1
- package/dist/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/models/external-document-inputs-dto.js +1 -1
- package/dist/models/file-meta-response-dto.d.ts +1 -1
- package/dist/models/file-meta-response-dto.js +1 -1
- package/dist/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/models/file-uploaded-response-dto.js +1 -1
- package/dist/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/models/generated-external-contract-document-dto.js +1 -1
- package/dist/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/models/get-bid-settlement200-response.js +1 -1
- package/dist/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/models/get-bid-statement200-response.js +1 -1
- package/dist/models/get-bid200-response.d.ts +1 -1
- package/dist/models/get-bid200-response.js +1 -1
- package/dist/models/get-file-meta200-response.d.ts +1 -1
- package/dist/models/get-file-meta200-response.js +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/models/get-webhook-endpoint200-response.d.ts +15 -0
- package/dist/models/get-webhook-endpoint200-response.js +15 -0
- package/dist/models/green-product-public.d.ts +1 -1
- package/dist/models/green-product-public.js +1 -1
- package/dist/models/health-controller-check200-response.d.ts +1 -1
- package/dist/models/health-controller-check200-response.js +1 -1
- package/dist/models/health-response-dto.d.ts +1 -1
- package/dist/models/health-response-dto.js +1 -1
- package/dist/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/models/hierarchical-region-dto.js +1 -1
- package/dist/models/index.d.ts +15 -0
- package/dist/models/index.js +15 -0
- package/dist/models/introspect-request-dto.d.ts +1 -1
- package/dist/models/introspect-request-dto.js +1 -1
- package/dist/models/introspection-response-dto.d.ts +1 -1
- package/dist/models/introspection-response-dto.js +1 -1
- package/dist/models/invalid-param-dto.d.ts +1 -1
- package/dist/models/invalid-param-dto.js +1 -1
- package/dist/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/models/invoice-completed-response-dto.js +1 -1
- package/dist/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/models/invoice-split-response-dto.js +1 -1
- package/dist/models/legal-mandatory-public.d.ts +1 -1
- package/dist/models/legal-mandatory-public.js +1 -1
- package/dist/models/list-bid-results200-response.d.ts +1 -1
- package/dist/models/list-bid-results200-response.js +1 -1
- package/dist/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/models/list-bids200-response-meta.js +1 -1
- package/dist/models/list-bids200-response.d.ts +1 -1
- package/dist/models/list-bids200-response.js +1 -1
- package/dist/models/list-products200-response.d.ts +1 -1
- package/dist/models/list-products200-response.js +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +22 -0
- package/dist/models/list-webhook-deliveries-response-dto.js +15 -0
- package/dist/models/list-webhook-deliveries200-response.d.ts +15 -0
- package/dist/models/list-webhook-deliveries200-response.js +15 -0
- package/dist/models/list-webhook-endpoints200-response.d.ts +17 -0
- package/dist/models/list-webhook-endpoints200-response.js +15 -0
- package/dist/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/models/mark-bid-failed201-response.js +1 -1
- package/dist/models/negotiation-score-dto.d.ts +1 -1
- package/dist/models/negotiation-score-dto.js +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/models/oauth-error-response-dto.js +1 -1
- package/dist/models/partner-webhook-delivery-status.d.ts +18 -0
- package/dist/models/partner-webhook-delivery-status.js +22 -0
- package/dist/models/partner-webhook-endpoint-status.d.ts +19 -0
- package/dist/models/partner-webhook-endpoint-status.js +23 -0
- package/dist/models/partner-webhook-event-type.d.ts +22 -0
- package/dist/models/partner-webhook-event-type.js +26 -0
- package/dist/models/payment-method-public.d.ts +1 -1
- package/dist/models/payment-method-public.js +1 -1
- package/dist/models/preconditions-dto.d.ts +1 -1
- package/dist/models/preconditions-dto.js +1 -1
- package/dist/models/problem-details-dto.d.ts +1 -1
- package/dist/models/problem-details-dto.js +1 -1
- package/dist/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/models/product-receipt-response-dto.js +1 -1
- package/dist/models/product-response-dto.d.ts +1 -1
- package/dist/models/product-response-dto.js +1 -1
- package/dist/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/models/protected-resource-metadata-dto.js +1 -1
- package/dist/models/register-award-request-dto.d.ts +1 -1
- package/dist/models/register-award-request-dto.js +1 -1
- package/dist/models/register-award201-response.d.ts +1 -1
- package/dist/models/register-award201-response.js +1 -1
- package/dist/models/register-bid201-response.d.ts +1 -1
- package/dist/models/register-bid201-response.js +1 -1
- package/dist/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/models/register-semo-contract-request-dto.js +1 -1
- package/dist/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/models/request-invoice-split-request-dto.js +1 -1
- package/dist/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/models/request-invoice-split200-response.js +1 -1
- package/dist/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/models/retiree-roster-input-dto.js +1 -1
- package/dist/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/models/retiree-roster-row-dto.js +1 -1
- package/dist/models/revert-award-request-dto.d.ts +1 -1
- package/dist/models/revert-award-request-dto.js +1 -1
- package/dist/models/revert-award200-response.d.ts +1 -1
- package/dist/models/revert-award200-response.js +1 -1
- package/dist/models/revoke-request-dto.d.ts +1 -1
- package/dist/models/revoke-request-dto.js +1 -1
- package/dist/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/models/send-webhook-test-event200-response.d.ts +15 -0
- package/dist/models/send-webhook-test-event200-response.js +15 -0
- package/dist/models/statement-document-dto.d.ts +1 -1
- package/dist/models/statement-document-dto.js +1 -1
- package/dist/models/statement-product-dto.d.ts +1 -1
- package/dist/models/statement-product-dto.js +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/models/supplier-tax-type.d.ts +1 -1
- package/dist/models/supplier-tax-type.js +1 -1
- package/dist/models/token-request-dto.d.ts +1 -1
- package/dist/models/token-request-dto.js +1 -1
- package/dist/models/token-response-dto.d.ts +1 -1
- package/dist/models/token-response-dto.js +1 -1
- package/dist/models/update-bid-request-dto.d.ts +1 -1
- package/dist/models/update-bid-request-dto.js +1 -1
- package/dist/models/update-bid200-response.d.ts +1 -1
- package/dist/models/update-bid200-response.js +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +27 -0
- package/dist/models/update-webhook-endpoint-request-dto.js +15 -0
- package/dist/models/upload-file-request-dto.d.ts +1 -1
- package/dist/models/upload-file-request-dto.js +1 -1
- package/dist/models/upload-file201-response.d.ts +1 -1
- package/dist/models/upload-file201-response.js +1 -1
- package/dist/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/models/upload-url-created-response-dto.js +1 -1
- package/dist/models/webhook-delivery-dto.d.ts +73 -0
- package/dist/models/webhook-delivery-dto.js +24 -0
- package/dist/models/webhook-endpoint-dto.d.ts +55 -0
- package/dist/models/webhook-endpoint-dto.js +15 -0
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +59 -0
- package/dist/models/webhook-endpoint-with-secret-dto.js +15 -0
- package/dist/models/webhook-test-result-dto.d.ts +25 -0
- package/dist/models/webhook-test-result-dto.js +15 -0
- package/docs/CreateWebhookEndpoint201Response.md +20 -0
- package/docs/CreateWebhookEndpointRequestDto.md +22 -0
- package/docs/EmbedApi.md +2 -2
- package/docs/EmbedLaunchResponseDto.md +3 -1
- package/docs/GetWebhookEndpoint200Response.md +20 -0
- package/docs/ListWebhookDeliveries200Response.md +20 -0
- package/docs/ListWebhookDeliveriesResponseDto.md +22 -0
- package/docs/ListWebhookEndpoints200Response.md +22 -0
- package/docs/PartnerApiApi.md +517 -0
- package/docs/PartnerWebhookDeliveryStatus.md +14 -0
- package/docs/PartnerWebhookEndpointStatus.md +11 -0
- package/docs/PartnerWebhookEventType.md +17 -0
- package/docs/SendWebhookTestEvent200Response.md +20 -0
- package/docs/UpdateWebhookEndpointRequestDto.md +24 -0
- package/docs/WebhookDeliveryDto.md +42 -0
- package/docs/WebhookEndpointDto.md +38 -0
- package/docs/WebhookEndpointWithSecretDto.md +40 -0
- package/docs/WebhookTestResultDto.md +24 -0
- package/index.ts +1 -1
- package/models/acceptance-result-response-dto.ts +1 -1
- package/models/acknowledge-product-receipt200-response.ts +1 -1
- package/models/acknowledge-products-request-dto.ts +1 -1
- package/models/api-catalog-dto.ts +1 -1
- package/models/api-catalog-entry-dto.ts +1 -1
- package/models/api-catalog-link-dto.ts +1 -1
- package/models/authorization-server-metadata-dto.ts +1 -1
- package/models/award-method-public.ts +1 -1
- package/models/award-registered-v2-response-dto.ts +1 -1
- package/models/award-reverted-v2-response-dto.ts +1 -1
- package/models/bid-acceptance-dto.ts +1 -1
- package/models/bid-attachment-input-dto.ts +1 -1
- package/models/bid-bond-dto.ts +1 -1
- package/models/bid-cancelled-response-dto.ts +1 -1
- package/models/bid-contact-dto.ts +1 -1
- package/models/bid-contacts-dto.ts +1 -1
- package/models/bid-contract-document-dto.ts +1 -1
- package/models/bid-delivery-terms-dto.ts +1 -1
- package/models/bid-detail-response-dto.ts +1 -1
- package/models/bid-document-dto.ts +1 -1
- package/models/bid-failed-v2-response-dto.ts +1 -1
- package/models/bid-item-dto.ts +1 -1
- package/models/bid-lifecycle-dto.ts +1 -1
- package/models/bid-manager-dto.ts +1 -1
- package/models/bid-payment-terms-dto.ts +1 -1
- package/models/bid-product-dto.ts +1 -1
- package/models/bid-public-status.ts +1 -1
- package/models/bid-registered-response-dto.ts +1 -1
- package/models/bid-result-participant-attachment-dto.ts +1 -1
- package/models/bid-result-participant-dto.ts +1 -1
- package/models/bid-results-response-dto.ts +1 -1
- package/models/bid-settlement-line-item-dto.ts +1 -1
- package/models/bid-settlement-participant-dto.ts +1 -1
- package/models/bid-settlement-response-dto.ts +1 -1
- package/models/bid-statement-response-dto.ts +1 -1
- package/models/bid-summary-dto.ts +1 -1
- package/models/bid-type-public.ts +1 -1
- package/models/bid-updated-response-dto.ts +1 -1
- package/models/cancel-bid-request-dto.ts +1 -1
- package/models/cancel-bid200-response.ts +1 -1
- package/models/card-payment-request-response-dto.ts +1 -1
- package/models/complete-acceptance-request-dto.ts +1 -1
- package/models/complete-acceptance200-response.ts +1 -1
- package/models/complete-invoice200-response.ts +1 -1
- package/models/complete-upload-request-dto.ts +1 -1
- package/models/contract-restriction-confirm-input-dto.ts +1 -1
- package/models/create-bid-request-dto.ts +1 -1
- package/models/create-card-payment-dto.ts +1 -1
- package/models/create-card-payment-request-dto.ts +1 -1
- package/models/create-card-payment200-response.ts +1 -1
- package/models/create-embed-launch201-response.ts +1 -1
- package/models/create-external-contract-documents-request-dto.ts +1 -1
- package/models/create-external-contract-documents-response-dto.ts +1 -1
- package/models/create-file-upload-url201-response.ts +1 -1
- package/models/create-upload-url-request-dto.ts +1 -1
- package/models/create-webhook-endpoint-request-dto.ts +30 -0
- package/models/create-webhook-endpoint201-response.ts +23 -0
- package/models/delivery-date-type-public.ts +1 -1
- package/models/delivery-method-public.ts +1 -1
- package/models/embed-launch-request-dto.ts +1 -1
- package/models/embed-launch-response-dto.ts +6 -2
- package/models/excellent-procurement-public.ts +1 -1
- package/models/external-contract-document-item-dto.ts +1 -1
- package/models/external-contract-documents-response-dto.ts +1 -1
- package/models/external-contract-item-dto.ts +1 -1
- package/models/external-contract-snapshot-dto.ts +1 -1
- package/models/external-document-inputs-dto.ts +1 -1
- package/models/file-meta-response-dto.ts +1 -1
- package/models/file-uploaded-response-dto.ts +1 -1
- package/models/generated-external-contract-document-dto.ts +1 -1
- package/models/get-bid-settlement200-response.ts +1 -1
- package/models/get-bid-statement200-response.ts +1 -1
- package/models/get-bid200-response.ts +1 -1
- package/models/get-file-meta200-response.ts +1 -1
- package/models/get-supplier-card-payable-v2200-response.ts +1 -1
- package/models/get-webhook-endpoint200-response.ts +23 -0
- package/models/green-product-public.ts +1 -1
- package/models/health-controller-check200-response.ts +1 -1
- package/models/health-response-dto.ts +1 -1
- package/models/hierarchical-region-dto.ts +1 -1
- package/models/index.ts +15 -0
- package/models/introspect-request-dto.ts +1 -1
- package/models/introspection-response-dto.ts +1 -1
- package/models/invalid-param-dto.ts +1 -1
- package/models/invoice-completed-response-dto.ts +1 -1
- package/models/invoice-split-response-dto.ts +1 -1
- package/models/legal-mandatory-public.ts +1 -1
- package/models/list-bid-results200-response.ts +1 -1
- package/models/list-bids200-response-meta.ts +1 -1
- package/models/list-bids200-response.ts +1 -1
- package/models/list-products200-response.ts +1 -1
- package/models/list-webhook-deliveries-response-dto.ts +30 -0
- package/models/list-webhook-deliveries200-response.ts +23 -0
- package/models/list-webhook-endpoints200-response.ts +27 -0
- package/models/mark-bid-failed-request-dto.ts +1 -1
- package/models/mark-bid-failed201-response.ts +1 -1
- package/models/negotiation-score-dto.ts +1 -1
- package/models/negotiation-scored-v2-response-dto.ts +1 -1
- package/models/oauth-error-response-dto.ts +1 -1
- package/models/partner-webhook-delivery-status.ts +28 -0
- package/models/partner-webhook-endpoint-status.ts +29 -0
- package/models/partner-webhook-event-type.ts +32 -0
- package/models/payment-method-public.ts +1 -1
- package/models/preconditions-dto.ts +1 -1
- package/models/problem-details-dto.ts +1 -1
- package/models/product-receipt-response-dto.ts +1 -1
- package/models/product-response-dto.ts +1 -1
- package/models/protected-resource-metadata-dto.ts +1 -1
- package/models/register-award-request-dto.ts +1 -1
- package/models/register-award201-response.ts +1 -1
- package/models/register-bid201-response.ts +1 -1
- package/models/register-semo-contract-request-dto.ts +1 -1
- package/models/request-invoice-split-request-dto.ts +1 -1
- package/models/request-invoice-split200-response.ts +1 -1
- package/models/retiree-roster-input-dto.ts +1 -1
- package/models/retiree-roster-row-dto.ts +1 -1
- package/models/revert-award-request-dto.ts +1 -1
- package/models/revert-award200-response.ts +1 -1
- package/models/revoke-request-dto.ts +1 -1
- package/models/semo-contract-registered-response-dto.ts +1 -1
- package/models/semo-contract-taxinvoice-status-response-dto.ts +1 -1
- package/models/send-webhook-test-event200-response.ts +23 -0
- package/models/statement-document-dto.ts +1 -1
- package/models/statement-product-dto.ts +1 -1
- package/models/submit-negotiation-scores-request-dto.ts +1 -1
- package/models/submit-negotiation-scores201-response.ts +1 -1
- package/models/supplier-card-payable-response-dto.ts +1 -1
- package/models/supplier-tax-type.ts +1 -1
- package/models/token-request-dto.ts +1 -1
- package/models/token-response-dto.ts +1 -1
- package/models/update-bid-request-dto.ts +1 -1
- package/models/update-bid200-response.ts +1 -1
- package/models/update-webhook-endpoint-request-dto.ts +39 -0
- package/models/upload-file-request-dto.ts +1 -1
- package/models/upload-file201-response.ts +1 -1
- package/models/upload-url-created-response-dto.ts +1 -1
- package/models/webhook-delivery-dto.ts +82 -0
- package/models/webhook-endpoint-dto.ts +67 -0
- package/models/webhook-endpoint-with-secret-dto.ts +71 -0
- package/models/webhook-test-result-dto.ts +31 -0
- package/package.json +1 -1
package/docs/PartnerApiApi.md
CHANGED
|
@@ -11,6 +11,8 @@ All URIs are relative to *https://partner-api.c-market.net*
|
|
|
11
11
|
|[**createCardPayment**](#createcardpayment) | **POST** /v2/card-payments | ๊ฒฐ์ ์ฐฝ ๋ฐํ|
|
|
12
12
|
|[**createExternalContractDocuments**](#createexternalcontractdocuments) | **POST** /v2/contract-documents | ๊ณ์ฝ์๋ฅ ์์ฑ|
|
|
13
13
|
|[**createFileUploadUrl**](#createfileuploadurl) | **POST** /v2/files/upload-url | ๋์ฉ๋ ์
๋ก๋ 1/2 โ ์
๋ก๋ ์ฃผ์ ๋ฐ๊ธ|
|
|
14
|
+
|[**createWebhookEndpoint**](#createwebhookendpoint) | **POST** /v2/webhook-endpoints | ์นํ
๊ตฌ๋
๋ฑ๋ก|
|
|
15
|
+
|[**deleteWebhookEndpoint**](#deletewebhookendpoint) | **DELETE** /v2/webhook-endpoints/{endpointId} | ์นํ
๊ตฌ๋
์ญ์ |
|
|
14
16
|
|[**downloadFile**](#downloadfile) | **GET** /files/{fileKey} | ํ์ผ ๋ค์ด๋ก๋|
|
|
15
17
|
|[**getBid**](#getbid) | **GET** /v2/bids/{bidRef} | ๊ณต๊ณ ์์ธ ์กฐํ|
|
|
16
18
|
|[**getBidSettlement**](#getbidsettlement) | **GET** /v2/bids/{bidRef}/settlement | ์ ์ฐ ์ ๋ณด ์กฐํ|
|
|
@@ -18,18 +20,24 @@ All URIs are relative to *https://partner-api.c-market.net*
|
|
|
18
20
|
|[**getFileMeta**](#getfilemeta) | **GET** /v2/files/{fileKey} | ํ์ผ ์ ๋ณด ์กฐํ|
|
|
19
21
|
|[**getSemoContractTaxinvoiceStatus**](#getsemocontracttaxinvoicestatus) | **GET** /v2/semo-contracts/{externalContractId}/tax-invoice | ๊ณ์ฐ์ ๋ฐํ ์ํ ์กฐํ|
|
|
20
22
|
|[**getSupplierCardPayableV2**](#getsuppliercardpayablev2) | **GET** /v2/suppliers/{memberId}/card-payable | ๊ณต๊ธ์ฌ ์นด๋๊ฒฐ์ ๊ฐ๋ฅ ์ฌ๋ถ|
|
|
23
|
+
|[**getWebhookEndpoint**](#getwebhookendpoint) | **GET** /v2/webhook-endpoints/{endpointId} | ์นํ
๊ตฌ๋
๋จ๊ฑด ์กฐํ|
|
|
21
24
|
|[**healthControllerCheck**](#healthcontrollercheck) | **GET** /health | Partner API ํฌ์ค์ฒดํฌ|
|
|
22
25
|
|[**listBidResults**](#listbidresults) | **GET** /v2/bid-results | ๊ณต๊ณ ๊ฒฐ๊ณผ ์กฐํ|
|
|
23
26
|
|[**listBids**](#listbids) | **GET** /v2/bids | ๊ณต๊ณ ๋ชฉ๋ก ์กฐํ|
|
|
24
27
|
|[**listExternalContractDocuments**](#listexternalcontractdocuments) | **GET** /v2/contract-documents | ๊ฑฐ๋์ ํ์ํ ๊ณ์ฝ์๋ฅ ๋ชฉ๋ก ์กฐํ|
|
|
28
|
+
|[**listWebhookDeliveries**](#listwebhookdeliveries) | **GET** /v2/webhook-deliveries | ์นํ
์ ์ก ์ด๋ ฅ ์กฐํ|
|
|
29
|
+
|[**listWebhookEndpoints**](#listwebhookendpoints) | **GET** /v2/webhook-endpoints | ์นํ
๊ตฌ๋
๋ชฉ๋ก ์กฐํ|
|
|
25
30
|
|[**markBidFailed**](#markbidfailed) | **POST** /v2/bids/{bidRef}/fail | ์ ์ฐฐ ์ฒ๋ฆฌ|
|
|
26
31
|
|[**registerAward**](#registeraward) | **POST** /v2/bids/{bidRef}/award | ๋์ฐฐ ๊ฒฐ๊ณผ ์ ์ก|
|
|
27
32
|
|[**registerBid**](#registerbid) | **POST** /v2/bids | ๊ณต๊ณ ๋ฑ๋ก|
|
|
28
33
|
|[**registerSemoContract**](#registersemocontract) | **POST** /v2/semo-contracts | ๊ณ์ฝ ๋ฐํ๋์ ๋ฑ๋ก|
|
|
29
34
|
|[**requestInvoiceSplit**](#requestinvoicesplit) | **POST** /v2/bids/{bidRef}/invoice-splits | ๊ณ์ฐ์ ๋ถํ ๋ฐ๊ธ ์ฒญ๊ตฌ|
|
|
30
35
|
|[**revertAward**](#revertaward) | **DELETE** /v2/bids/{bidRef}/award | ๋์ฐฐ ๋๋๋ฆฌ๊ธฐ|
|
|
36
|
+
|[**rotateWebhookSecret**](#rotatewebhooksecret) | **POST** /v2/webhook-endpoints/{endpointId}/rotate-secret | ์นํ
์๋ช
์ํฌ๋ฆฟ ์ฌ๋ฐ๊ธ|
|
|
37
|
+
|[**sendWebhookTestEvent**](#sendwebhooktestevent) | **POST** /v2/webhook-endpoints/{endpointId}/test | ์นํ
์ฐ๊ฒฐ ํ์ธ ๋ฐ์ก|
|
|
31
38
|
|[**submitNegotiationScores**](#submitnegotiationscores) | **POST** /v2/bids/{bidRef}/negotiation-scores | ํ์ ์ ์ํ๊ฐ|
|
|
32
39
|
|[**updateBid**](#updatebid) | **PATCH** /v2/bids/{bidRef} | ๊ณต๊ณ ์์ |
|
|
40
|
+
|[**updateWebhookEndpoint**](#updatewebhookendpoint) | **PATCH** /v2/webhook-endpoints/{endpointId} | ์นํ
๊ตฌ๋
์์ |
|
|
33
41
|
|[**uploadFile**](#uploadfile) | **POST** /v2/files | ๊ณต๊ณ ์ฒจ๋ถํ์ผ ์
๋ก๋ (๊ธฐ๋ณธ)|
|
|
34
42
|
|
|
35
43
|
# **cancelBid**
|
|
@@ -488,6 +496,138 @@ const { status, data } = await apiInstance.createFileUploadUrl(
|
|
|
488
496
|
|
|
489
497
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
490
498
|
|
|
499
|
+
# **createWebhookEndpoint**
|
|
500
|
+
> CreateWebhookEndpoint201Response createWebhookEndpoint(createWebhookEndpointRequestDto)
|
|
501
|
+
|
|
502
|
+
์์ ์ฃผ์์ ๊ตฌ๋
ํ ์ด๋ฒคํธ๋ฅผ ๋ฑ๋กํฉ๋๋ค. **ํธ์ถ ์์ :** ์ฐ๋ ์ด๊ธฐ 1ํ. ์์ ์ฃผ์๊ฐ ๋ฐ๋๋ฉด ์๋ก ๋ง๋ค์ง ๋ง๊ณ `PATCH` ๋ก ๊ณ ์น์ธ์ โ ๊ทธ๋์ผ ์ํฌ๋ฆฟ๊ณผ ์ ์ก ์ด๋ ฅ์ด ์ ์ง๋ฉ๋๋ค. **์๋ช
์ํฌ๋ฆฟ์ ์ด ์๋ต์์ ํ ๋ฒ๋ง ๋๊ฐ๋๋ค.** ์๋ฒ๋ ํด์๋ง ๋ณด๊ดํ๋ฏ๋ก ์กฐํ๋ก ๋ค์ ๋ฐ์ ์ ์์ต๋๋ค. ์๋ต์ `secret` ์ ์ฆ์ ์์ ํ ๊ณณ์ ๋ณด๊ดํ์ธ์. ์์ด๋ฒ๋ ธ๋ค๋ฉด ๋ณต๊ตฌ๊ฐ ์๋๋ผ `POST /v2/webhook-endpoints/{endpointId}/rotate-secret` ์ผ๋ก **์ฌ๋ฐ๊ธ**ํด์ผ ํฉ๋๋ค. **๊ฑฐ์ ๋๋ ๊ฒฝ์ฐ์ ๊ณ ์น๋ ๋ฒ:** - `400` โ `url` ์ด HTTPS ๊ฐ ์๋๊ฑฐ๋ ํ์์ด ์๋ชป๋จ, `eventTypes` ๊ฐ ๋น์๊ฑฐ๋ ๋ชฉ๋ก ๋ฐ ๊ฐ (`ping` ์ ๊ตฌ๋
๋ถ๊ฐ). ๊ฐ์ ๊ณ ์ณ ์ฌ์๋ํ์ธ์. - `400` โ `Idempotency-Key` ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ. UUID v4 ๋ฅผ ์ค์ด ๋ณด๋ด์ธ์. - `403` โ ํ ํฐ์ `webhooks:write` ์ค์ฝํ๊ฐ ์์. ํค ๋ฐ๊ธ ์ค์ ์ ๋ํ์ผ ํฉ๋๋ค. **ํ์ ์ค์ฝํ:** `webhooks:write` **๋ฉฑ๋ฑ์ฑ:** `Idempotency-Key` ํค๋ ํ์. ### ์๋ช
๊ฒ์ฆ (ํ์) ์๋ช
์ **[Standard Webhooks](https://www.standardwebhooks.com)** ๊ท์ฝ์ ๊ทธ๋๋ก ๋ฐ๋ฆ
๋๋ค. ์ง์ ๊ตฌํํ์ง ๋ง๊ณ ๊ฐ ์ธ์ด์ `standardwebhooks` ๋ผ์ด๋ธ๋ฌ๋ฆฌ์ ๋ฑ๋ก ์ ๋ฐ์ ์ํฌ๋ฆฟ (`whsec_โฆ`)์ ๊ทธ๋๋ก ๋๊ธฐ์ธ์ โ ๊ทธ๊ฒ์ด ์ด ํ์์ ์ฐ๋ ์ด์ ์
๋๋ค. ```java // Java Webhook webhook = new Webhook(secret); // secret = \"whsec_โฆ\" webhook.verify(rawBody, headers); // ์คํจํ๋ฉด ์์ธ ``` ```ts // Node / TypeScript import { Webhook } from \'standardwebhooks\'; new Webhook(secret).verify(rawBody, headers); ``` ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ์ธ ์ ์๋ค๋ฉด ๋ฐ์ก ์์ฒญ์ ์ค๋ฆฌ๋ ํค๋๋ ์
์
๋๋ค. ``` webhook-id: evt_01J8Z7Q3K9 webhook-timestamp: 1774915200 webhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4= ``` 1. ์ํฌ๋ฆฟ์์ `whsec_` ์ ๋์ด๋ฅผ ๋ผ๊ณ **base64 ๋์ฝ๋**ํฉ๋๋ค โ ๊ทธ ๋ฐ์ดํธ๊ฐ HMAC ํค์
๋๋ค (์ํฌ๋ฆฟ ๋ฌธ์์ด ์์ฒด๊ฐ ์๋๋๋ค). 2. `\"${webhook-id}.${webhook-timestamp}.${๋ณธ๋ฌธ ์๋ฌธ}\"` ์ ๋ง๋ญ๋๋ค. **๋ณธ๋ฌธ์ ํ์ฑ ์ ์๋ฌธ ๋ฐ์ดํธ**์ฌ์ผ ํฉ๋๋ค โ JSON ์ ๋ค์ ์ง๋ ฌํํ๋ฉด ๊ณต๋ฐฑยทํค ์์๊ฐ ๋ฌ๋ผ์ ธ ์๋ช
์ด ๋ง์ง ์์ต๋๋ค. 3. HMAC-SHA256 ์ ๊ณ์ฐํด **base64** ๋ก ์ธ์ฝ๋ฉํ๊ณ , `webhook-signature` ์ `v1,` ๋ค ๊ฐ๊ณผ ๋น๊ตํฉ๋๋ค. ๋น๊ต๋ **์์ ์๊ฐ** ํจ์๋ฅผ ์ฐ์ธ์(Node `crypto.timingSafeEqual`, Java `MessageDigest.isEqual`). 4. `webhook-timestamp` ๊ฐ ํ์ฌ ์๊ฐ์์ **5๋ถ** ์ด์ ์ง๋ฌ์ผ๋ฉด ๊ฑฐ์ ํ์ธ์(์ฌ์ ์ก ๊ณต๊ฒฉ ๋ฐฉ์ด). `webhook-signature` ๋ ๊ณต๋ฐฑ์ผ๋ก ๊ตฌ๋ถ๋ **์ฌ๋ฌ ์๋ช
**์ ์ค์ ์ ์๋ ํ์์
๋๋ค(ํค ํ์ ์ฉ). ์ง๊ธ์ ํญ์ ํ๋์ง๋ง, ๊ฒ์ฆ๊ธฐ๋ ๋ชฉ๋ก์ผ๋ก ์ฝ๊ณ **ํ๋๋ผ๋ ๋ง์ผ๋ฉด ํต๊ณผ**ํ๋๋ก ์ง์ธ์. ### ์ค๋ณต ์ ๊ฑฐ `webhook-id` ํค๋๊ฐ ์ด๋ฒคํธ ์๋ณ์์
๋๋ค. **์ฌ์๋์๋ ๊ฐ์ ๊ฐ์ด ์ต๋๋ค** โ ์ด๋ฏธ ์ฒ๋ฆฌํ ๊ฐ์ด๋ฉด ๋ฌด์ํ์ธ์. ๊ฐ์ ์ด๋ฒคํธ๋ฅผ ๋ ๋ฒ ๋ฐ๋ ๊ฒ์ ์ ์ ๋์์ด๋ฉฐ, ์ค๋ณต ์ ๊ฑฐ๋ ์์ ์ธก ์ฑ
์์
๋๋ค. ํธ์๋ฅผ ์ํด `webhook-event-type` ํค๋์ ์ด๋ฒคํธ ํ์
(๋ณธ๋ฌธ `type` ๊ณผ ๊ฐ์ ๊ฐ)๋ ์ค๋ฆฝ๋๋ค โ ๋ณธ๋ฌธ์ ํ์ฑํ๊ธฐ ์ ์ ๊ด์ฌ ์๋ ํ์
์ ๋ฒ๋ฆด ์ ์์ต๋๋ค. ํ์ค์๋ ์๋ ํ์ฅ์ด๋ผ ๊ฒ์ฆ ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ ์ด ํค๋๋ฅผ ๋ฌด์ํฉ๋๋ค. ### ์๋ต๊ณผ ์ฌ์๋ 2xx ๋ฅผ ๋๋ ค์ฃผ๋ฉด ์ฑ๊ณต์
๋๋ค. ๊ทธ ์ธ(๋๋ ๋ฌด์๋ต)๋ ์คํจ๋ก ๋ณด๊ณ ์ต๋ 7ํ ์ฌ์๋ํฉ๋๋ค โ ๊ฐ๊ฒฉ์ 10์ด โ 1๋ถ โ 5๋ถ โ 30๋ถ โ 2์๊ฐ โ 6์๊ฐ โ 24์๊ฐ ์
๋๋ค. ์ฒ๋ฆฌ ์๊ฐ์ด ๊ธธ๋ฉด ๋จผ์ 2xx ๋ฅผ ๋๋ ค์ฃผ๊ณ ๋น๋๊ธฐ๋ก ์ฒ๋ฆฌํ์ธ์. ์ฐ์ ์คํจ๊ฐ 20ํ์ ๋ฟ์ผ๋ฉด ๊ตฌ๋
์ด ์๋์ผ๋ก `DISABLED` ๋ก ๋ด๋ ค๊ฐ๊ณ ๋ฐ์ก์ด ๋ฉ์ถฅ๋๋ค. ์์ ์ธก์ ๊ณ ์น ๋ค `PATCH /v2/webhook-endpoints/{endpointId}` ์ `{\"status\":\"ACTIVE\"}` ๋ก ๋์ด๋ฆฌ์ธ์. ### ๊ตฌ๋
๊ฐ๋ฅํ ์ด๋ฒคํธ `bid.closed` ยท `bid.awarded` ยท `bid.failed` ยท `bid.canceled` ยท `bid.award_reverted` `ping` ์ ์ฐ๊ฒฐ ํ์ธ ์ ์ฉ์ด๋ผ ๊ตฌ๋
ํ ์ ์์ต๋๋ค โ ํ
์คํธ ๋ฐ์ก ๊ฒฝ๋ก์์๋ง ๋๊ฐ๋๋ค. ### ๋์น ์ด๋ฒคํธ ํ์ธ `GET /v2/webhook-deliveries` ๊ฐ ๋ฐ์ก ์๋ ์ด๋ ฅ(๋ณธ๋ฌธยท์๋ต ์ํยท๋ค์ ์ฌ์๋ ์๊ฐ)์ ๋๋ ค์ค๋๋ค. ์์ ์ธก ์ฅ์ ๊ตฌ๊ฐ์ ๋ฉ์ธ ๋ ์ด ์๋ํฌ์ธํธ๋ฅผ ํด๋ง ๋์ฒด ๊ฒฝ๋ก๋ก ์ฐ์ธ์.
|
|
503
|
+
|
|
504
|
+
### Example
|
|
505
|
+
|
|
506
|
+
```typescript
|
|
507
|
+
import {
|
|
508
|
+
PartnerApiApi,
|
|
509
|
+
Configuration,
|
|
510
|
+
CreateWebhookEndpointRequestDto
|
|
511
|
+
} from '@cmarket/partner-sdk';
|
|
512
|
+
|
|
513
|
+
const configuration = new Configuration();
|
|
514
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
515
|
+
|
|
516
|
+
let idempotencyKey: string; //๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. (default to undefined)
|
|
517
|
+
let createWebhookEndpointRequestDto: CreateWebhookEndpointRequestDto; //
|
|
518
|
+
|
|
519
|
+
const { status, data } = await apiInstance.createWebhookEndpoint(
|
|
520
|
+
idempotencyKey,
|
|
521
|
+
createWebhookEndpointRequestDto
|
|
522
|
+
);
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Parameters
|
|
526
|
+
|
|
527
|
+
|Name | Type | Description | Notes|
|
|
528
|
+
|------------- | ------------- | ------------- | -------------|
|
|
529
|
+
| **createWebhookEndpointRequestDto** | **CreateWebhookEndpointRequestDto**| | |
|
|
530
|
+
| **idempotencyKey** | [**string**] | ๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. | defaults to undefined|
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
**CreateWebhookEndpoint201Response**
|
|
536
|
+
|
|
537
|
+
### Authorization
|
|
538
|
+
|
|
539
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
540
|
+
|
|
541
|
+
### HTTP request headers
|
|
542
|
+
|
|
543
|
+
- **Content-Type**: application/json
|
|
544
|
+
- **Accept**: application/json, application/problem+json
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
### HTTP response details
|
|
548
|
+
| Status code | Description | Response headers |
|
|
549
|
+
|-------------|-------------|------------------|
|
|
550
|
+
|**201** | ๊ตฌ๋
๋ฑ๋ก ์๋ฃ. `secret` ์ ์ด ์๋ต์๋ง ์ค๋ฆฝ๋๋ค. | - |
|
|
551
|
+
|**400** | ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`), Idempotency-Key ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ(`โฆ/idempotency-key-required`, `โฆ/idempotency-key-invalid`), ๋๋ ์์ฒญ ๋ด์ฉ์ด ์ ํจํ์ง ์์(`โฆ/upstream-invalid-input`). | - |
|
|
552
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
553
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
554
|
+
|**409** | ์ ์์ฒญ์ด ์์ง ์ฒ๋ฆฌ ์ค์ธ ์ํ์์ ๊ฐ์ Idempotency-Key ์ฌ์ ์ก(`type: โฆ/idempotency-key-conflict` โ ์ ์ ๋ค ๊ฐ์ ํค๋ก ์ฌ์๋ํ๋ฉด ๊ฒฐ๊ณผ๋ฅผ ๋ฐ๋๋ค) ๋๋ ํ์ฌ ์ํ์ ์ถฉ๋ํ๋ ์์ฒญ(`โฆ/upstream-conflict`). | - |
|
|
555
|
+
|**422** | ๋์ผ Idempotency-Key ๋ฅผ **๋ค๋ฅธ body** ๋ก ์ฌ์ ์ก(`type: โฆ/idempotency-key-reused`). ์ฌ์๋ํด๋ ๋์ผ ์คํจ โ ์ ํค๋ฅผ ์ฐ๊ฑฐ๋ body ๋ฅผ ์๋๋๋ก ๋๋๋ ค์ผ ํ๋ค. ํ์์ ๋ง์ง๋ง ๋ด์ฉ์ ์ฒ๋ฆฌํ ์ ์๋ ์์ฒญ(`โฆ/upstream-unprocessable`)๋ ์ด ์ํ๋ค. | - |
|
|
556
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
557
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
558
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
559
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
560
|
+
|
|
561
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
562
|
+
|
|
563
|
+
# **deleteWebhookEndpoint**
|
|
564
|
+
> deleteWebhookEndpoint()
|
|
565
|
+
|
|
566
|
+
๊ตฌ๋
์ ์ญ์ ํฉ๋๋ค. ์ดํ ๊ทธ ์ฃผ์๋ก๋ ์๋ฌด ์ด๋ฒคํธ๋ ๋ฐ์ก๋์ง ์์ต๋๋ค. **ํธ์ถ ์์ :** ์ฐ๋์ ์ข
๋ฃํ ๋. ์ ์๋ง ๋ฉ์ถ๋ ค๋ฉด ์ญ์ ํ์ง ๋ง๊ณ `PATCH โฆ {\"status\":\"DISABLED\"}` ๋ฅผ ์ฐ์ธ์ โ ์ํฌ๋ฆฟ๊ณผ ์ด๋ฒคํธ ๊ตฌ์ฑ์ด ๋จ์ ๊ทธ๋๋ก ๋์ด๋ฆด ์ ์์ต๋๋ค. **๋๋๋ฆด ์ ์์ต๋๋ค.** ๋ค์ ๋ฑ๋กํ๋ฉด ์ ๊ตฌ๋
์ด๊ณ ์๋ช
์ํฌ๋ฆฟ๋ ์ ๊ฐ์
๋๋ค. **`If-Match` ๊ฐ ํ์์
๋๋ค.** `GET` ์ผ๋ก ๋ฐ์ `ETag` ๋ฅผ ์ค์ด ๋ณด๋ด์ธ์. - `428` โ ํค๋ ๋๋ฝ. ์กฐํ ํ ์ฌ์๋ํ์ธ์. - `412` โ ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ต๋๋ค(๋๊ตฐ๊ฐ ์์ ํ๊ฑฐ๋ ๋ฐ์ก๊ธฐ๊ฐ ์ํ๋ฅผ ๋ด๋ ธ์ต๋๋ค). ๋ค์ ์กฐํํด ์ ๋ง ์ง์ธ ๋์์ด ๋ง๋์ง ํ์ธํ๊ณ ์ต์ `ETag` ๋ก ์ฌ์๋ํ์ธ์. **ํ์ ์ค์ฝํ:** `webhooks:write` **๋ฉฑ๋ฑ์ฑ:** `Idempotency-Key` ํค๋ ํ์.
|
|
567
|
+
|
|
568
|
+
### Example
|
|
569
|
+
|
|
570
|
+
```typescript
|
|
571
|
+
import {
|
|
572
|
+
PartnerApiApi,
|
|
573
|
+
Configuration
|
|
574
|
+
} from '@cmarket/partner-sdk';
|
|
575
|
+
|
|
576
|
+
const configuration = new Configuration();
|
|
577
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
578
|
+
|
|
579
|
+
let endpointId: string; //๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). (default to undefined)
|
|
580
|
+
let ifMatch: string; //์ง์ ์กฐํ ์๋ต์ `ETag` ๊ฐ. ๋๋ฝํ๋ฉด 428, ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ผ๋ฉด 412 ๋ก ๊ฑฐ์ ๋๋ฉฐ ์๋ฌด๊ฒ๋ ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. (default to undefined)
|
|
581
|
+
let idempotencyKey: string; //๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. (default to undefined)
|
|
582
|
+
|
|
583
|
+
const { status, data } = await apiInstance.deleteWebhookEndpoint(
|
|
584
|
+
endpointId,
|
|
585
|
+
ifMatch,
|
|
586
|
+
idempotencyKey
|
|
587
|
+
);
|
|
588
|
+
```
|
|
589
|
+
|
|
590
|
+
### Parameters
|
|
591
|
+
|
|
592
|
+
|Name | Type | Description | Notes|
|
|
593
|
+
|------------- | ------------- | ------------- | -------------|
|
|
594
|
+
| **endpointId** | [**string**] | ๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). | defaults to undefined|
|
|
595
|
+
| **ifMatch** | [**string**] | ์ง์ ์กฐํ ์๋ต์ `ETag` ๊ฐ. ๋๋ฝํ๋ฉด 428, ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ผ๋ฉด 412 ๋ก ๊ฑฐ์ ๋๋ฉฐ ์๋ฌด๊ฒ๋ ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. | defaults to undefined|
|
|
596
|
+
| **idempotencyKey** | [**string**] | ๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. | defaults to undefined|
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
void (empty response body)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: application/problem+json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
|**204** | ๊ตฌ๋
์ญ์ ์๋ฃ(๋ณธ๋ฌธ ์์). | - |
|
|
617
|
+
|**400** | ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`), Idempotency-Key ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ(`โฆ/idempotency-key-required`, `โฆ/idempotency-key-invalid`), ๋๋ ์์ฒญ ๋ด์ฉ์ด ์ ํจํ์ง ์์(`โฆ/upstream-invalid-input`). | - |
|
|
618
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
619
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
620
|
+
|**409** | ์ ์์ฒญ์ด ์์ง ์ฒ๋ฆฌ ์ค์ธ ์ํ์์ ๊ฐ์ Idempotency-Key ์ฌ์ ์ก(`type: โฆ/idempotency-key-conflict` โ ์ ์ ๋ค ๊ฐ์ ํค๋ก ์ฌ์๋ํ๋ฉด ๊ฒฐ๊ณผ๋ฅผ ๋ฐ๋๋ค) ๋๋ ํ์ฌ ์ํ์ ์ถฉ๋ํ๋ ์์ฒญ(`โฆ/upstream-conflict`). | - |
|
|
621
|
+
|**412** | `If-Match` ์ง๋ฌธ์ด ํ์ฌ ๋ฆฌ์์ค์ ๋ค๋ฆ
๋๋ค(`type: โฆ/precondition-failed`). ๊ทธ ์ฌ์ด ๋ค๋ฅธ ์์ฒญ์ด ๋ฆฌ์์ค๋ฅผ ๋ฐ๊ฟจ์ต๋๋ค โ ๋ค์ ์กฐํํด ์ต์ ETag ๋ก ์ฌ์๋ํ์ธ์. | - |
|
|
622
|
+
|**422** | ๋์ผ Idempotency-Key ๋ฅผ **๋ค๋ฅธ body** ๋ก ์ฌ์ ์ก(`type: โฆ/idempotency-key-reused`). ์ฌ์๋ํด๋ ๋์ผ ์คํจ โ ์ ํค๋ฅผ ์ฐ๊ฑฐ๋ body ๋ฅผ ์๋๋๋ก ๋๋๋ ค์ผ ํ๋ค. ํ์์ ๋ง์ง๋ง ๋ด์ฉ์ ์ฒ๋ฆฌํ ์ ์๋ ์์ฒญ(`โฆ/upstream-unprocessable`)๋ ์ด ์ํ๋ค. | - |
|
|
623
|
+
|**428** | `If-Match` ํค๋๊ฐ ์์ต๋๋ค(`type: โฆ/if-match-required`). ์์ด๋ฒ๋ฆฐ ๊ฐฑ์ ์ ๋ง๊ธฐ ์ํด ํ์์
๋๋ค. | - |
|
|
624
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
625
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
626
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
627
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
628
|
+
|
|
629
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
630
|
+
|
|
491
631
|
# **downloadFile**
|
|
492
632
|
> downloadFile()
|
|
493
633
|
|
|
@@ -888,6 +1028,65 @@ const { status, data } = await apiInstance.getSupplierCardPayableV2(
|
|
|
888
1028
|
|
|
889
1029
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
890
1030
|
|
|
1031
|
+
# **getWebhookEndpoint**
|
|
1032
|
+
> GetWebhookEndpoint200Response getWebhookEndpoint()
|
|
1033
|
+
|
|
1034
|
+
๊ตฌ๋
1๊ฑด์ ํ์ฌ ์ํ๋ฅผ ์กฐํํฉ๋๋ค. ์๋ช
์ํฌ๋ฆฟ์ ์ค๋ฆฌ์ง ์์ต๋๋ค. **์์ ยท์ญ์ ์ ์ ๋จผ์ ํธ์ถํ์ธ์.** ์๋ต ํค๋ `ETag` ๋ฅผ `If-Match` ์ ๊ทธ๋๋ก ์ค์ด์ผ `PATCH`/`DELETE` ๊ฐ ํต๊ณผํฉ๋๋ค. **`404`:** ์๋ ๊ตฌ๋
์ด๊ฑฐ๋ ๋ค๋ฅธ ํํธ๋ ํค์ ๊ตฌ๋
์
๋๋ค โ `endpointId` ๋ฅผ ํ์ธํ์ธ์. **ํ์ ์ค์ฝํ:** `webhooks:read`
|
|
1035
|
+
|
|
1036
|
+
### Example
|
|
1037
|
+
|
|
1038
|
+
```typescript
|
|
1039
|
+
import {
|
|
1040
|
+
PartnerApiApi,
|
|
1041
|
+
Configuration
|
|
1042
|
+
} from '@cmarket/partner-sdk';
|
|
1043
|
+
|
|
1044
|
+
const configuration = new Configuration();
|
|
1045
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1046
|
+
|
|
1047
|
+
let endpointId: string; //๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). (default to undefined)
|
|
1048
|
+
|
|
1049
|
+
const { status, data } = await apiInstance.getWebhookEndpoint(
|
|
1050
|
+
endpointId
|
|
1051
|
+
);
|
|
1052
|
+
```
|
|
1053
|
+
|
|
1054
|
+
### Parameters
|
|
1055
|
+
|
|
1056
|
+
|Name | Type | Description | Notes|
|
|
1057
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1058
|
+
| **endpointId** | [**string**] | ๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). | defaults to undefined|
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
### Return type
|
|
1062
|
+
|
|
1063
|
+
**GetWebhookEndpoint200Response**
|
|
1064
|
+
|
|
1065
|
+
### Authorization
|
|
1066
|
+
|
|
1067
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1068
|
+
|
|
1069
|
+
### HTTP request headers
|
|
1070
|
+
|
|
1071
|
+
- **Content-Type**: Not defined
|
|
1072
|
+
- **Accept**: application/json, application/problem+json
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
### HTTP response details
|
|
1076
|
+
| Status code | Description | Response headers |
|
|
1077
|
+
|-------------|-------------|------------------|
|
|
1078
|
+
|**200** | ์นํ
๊ตฌ๋
์์ธ. | * ETag - ๋ฆฌ์์ค ์ง๋ฌธ(weak). ๋ค์ ์์ฒญ์ `If-None-Match` ํค๋๋ก ๋๋ณด๋ด๋ฉด ๋ด์ฉ์ด ๊ทธ๋๋ก์ผ ๋ `304 Not Modified` ๋ฅผ ๋ณธ๋ฌธ ์์ด ๋ฐ์ต๋๋ค. <br> |
|
|
1079
|
+
|**400** | ์ฟผ๋ฆฌ/๋ณธ๋ฌธ ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`) โ ์ํ ์ด๊ณผ(`bidRefs` 101๊ฑด ๋ฑ), ๊ฐ ํ์ ์๋ฐ, ์ ์ ์๋ `cursor` ๋ฑ. | - |
|
|
1080
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
1081
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
1082
|
+
|**404** | ๋์์ ์ฐพ์ ์ ์์ต๋๋ค(`type: โฆ/upstream-not-found`). | - |
|
|
1083
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
1084
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
1085
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
1086
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
1087
|
+
|
|
1088
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1089
|
+
|
|
891
1090
|
# **healthControllerCheck**
|
|
892
1091
|
> HealthControllerCheck200Response healthControllerCheck()
|
|
893
1092
|
|
|
@@ -1126,6 +1325,126 @@ const { status, data } = await apiInstance.listExternalContractDocuments(
|
|
|
1126
1325
|
|
|
1127
1326
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1128
1327
|
|
|
1328
|
+
# **listWebhookDeliveries**
|
|
1329
|
+
> ListWebhookDeliveries200Response listWebhookDeliveries()
|
|
1330
|
+
|
|
1331
|
+
์ด API ํค์ ์นํ
๋ฐ์ก ์๋๋ฅผ ์ต์ ์์ผ๋ก ์กฐํํฉ๋๋ค. ๋ณด๋ธ ๋ณธ๋ฌธยท์์ ์ธก ์๋ต ์ํยท ๋ค์ ์ฌ์๋ ์์ ์๊ฐ์ด ํจ๊ป ์ค๋ฆฝ๋๋ค. **ํธ์ถ ์์ :** - ์์ ์ธก ์ฅ์ ๋ก ๋์น ์ด๋ฒคํธ๋ฅผ ๋ฉ์ธ ๋. ์ด ์๋ํฌ์ธํธ๊ฐ ์นํ
์ **ํด๋ง ๋์ฒด ๊ฒฝ๋ก**์
๋๋ค โ `status=EXHAUSTED` ๋ก ๊ฑธ๋ฌ ๋ค์ ์ฒ๋ฆฌํ๋ฉด ๋ฉ๋๋ค. - \"์ด๋ฒคํธ๊ฐ ์ ์จ๋ค\" ๋ฅผ ์ง๋จํ ๋. ๋ฐ์ก ์๋ ์์ฒด๊ฐ ์๋์ง(๊ตฌ๋
ยท์ด๋ฒคํธ ํ์
๋ฌธ์ ), ์๋ํ์ง๋ง ์คํจํ๋์ง(`responseStatus`ยท`responseBodyExcerpt`)๋ฅผ ์ฌ๊ธฐ์ ๊ฐ๋ฆ
๋๋ค. **๊ฐ์ ์ด๋ฒคํธ๊ฐ ์ฌ๋ฌ ํ์ผ๋ก ๋ณด์
๋๋ค.** ์ฌ์๋๋ง๋ค ํ ํ์ด๋ฉฐ `eventId` ๊ฐ ๊ฐ๊ณ `attempt` ๋ง ์ฌ๋ผ๊ฐ๋๋ค. ์ฒ๋ฆฌ ์ฌ๋ถ๋ `eventId` ๊ธฐ์ค์ผ๋ก ํ๋จํ์ธ์. **ํ์ด์ง๋ค์ด์
:** `nextCursor` ๋ฅผ ๋ค์ ์์ฒญ์ `cursor` ๋ก ์ ๋ฌํฉ๋๋ค. null ์ด๋ฉด ๋ง์ง๋ง ํ์ด์ง์
๋๋ค. **`400`:** `status` ๊ฐ ํ์ฉ ๊ฐ ๋ฐ์ด๊ฑฐ๋ `limit` ์ด ๋ฒ์๋ฅผ ๋ฒ์ด๋ฌ์ต๋๋ค โ ๊ฐ์ ๊ณ ์ณ ์ฌ์๋ํ์ธ์. **ํ์ ์ค์ฝํ:** `webhooks:read`
|
|
1332
|
+
|
|
1333
|
+
### Example
|
|
1334
|
+
|
|
1335
|
+
```typescript
|
|
1336
|
+
import {
|
|
1337
|
+
PartnerApiApi,
|
|
1338
|
+
Configuration
|
|
1339
|
+
} from '@cmarket/partner-sdk';
|
|
1340
|
+
|
|
1341
|
+
const configuration = new Configuration();
|
|
1342
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1343
|
+
|
|
1344
|
+
let endpointId: string; //์ด ๊ตฌ๋
์ ์ ์ก๋ง ์กฐํํฉ๋๋ค. ๋ฏธ์ง์ ์ด๋ฉด ์ด ํค์ ๋ชจ๋ ๊ตฌ๋
์ ํจ๊ป ์กฐํํฉ๋๋ค. (optional) (default to undefined)
|
|
1345
|
+
let status: PartnerWebhookDeliveryStatus; //์ ์ก ์ํ ํํฐ. ๋ฏธ์ง์ ์ด๋ฉด ์ ๋ถ. (optional) (default to undefined)
|
|
1346
|
+
let limit: number; //ํ์ด์ง ํฌ๊ธฐ(1~200, ๊ธฐ๋ณธ 50). (optional) (default to 50)
|
|
1347
|
+
let cursor: string; //๋ค์ ํ์ด์ง ์ปค์(๋ถํฌ๋ช
ํ ํฐ). ์ง์ ์๋ต์ `nextCursor` ๋ฅผ ๊ทธ๋๋ก ์ ๋ฌํฉ๋๋ค. ๋ฏธ์ง์ ์ ์ฒซ ํ์ด์ง. (optional) (default to undefined)
|
|
1348
|
+
|
|
1349
|
+
const { status, data } = await apiInstance.listWebhookDeliveries(
|
|
1350
|
+
endpointId,
|
|
1351
|
+
status,
|
|
1352
|
+
limit,
|
|
1353
|
+
cursor
|
|
1354
|
+
);
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
### Parameters
|
|
1358
|
+
|
|
1359
|
+
|Name | Type | Description | Notes|
|
|
1360
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1361
|
+
| **endpointId** | [**string**] | ์ด ๊ตฌ๋
์ ์ ์ก๋ง ์กฐํํฉ๋๋ค. ๋ฏธ์ง์ ์ด๋ฉด ์ด ํค์ ๋ชจ๋ ๊ตฌ๋
์ ํจ๊ป ์กฐํํฉ๋๋ค. | (optional) defaults to undefined|
|
|
1362
|
+
| **status** | **PartnerWebhookDeliveryStatus** | ์ ์ก ์ํ ํํฐ. ๋ฏธ์ง์ ์ด๋ฉด ์ ๋ถ. | (optional) defaults to undefined|
|
|
1363
|
+
| **limit** | [**number**] | ํ์ด์ง ํฌ๊ธฐ(1~200, ๊ธฐ๋ณธ 50). | (optional) defaults to 50|
|
|
1364
|
+
| **cursor** | [**string**] | ๋ค์ ํ์ด์ง ์ปค์(๋ถํฌ๋ช
ํ ํฐ). ์ง์ ์๋ต์ `nextCursor` ๋ฅผ ๊ทธ๋๋ก ์ ๋ฌํฉ๋๋ค. ๋ฏธ์ง์ ์ ์ฒซ ํ์ด์ง. | (optional) defaults to undefined|
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
### Return type
|
|
1368
|
+
|
|
1369
|
+
**ListWebhookDeliveries200Response**
|
|
1370
|
+
|
|
1371
|
+
### Authorization
|
|
1372
|
+
|
|
1373
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1374
|
+
|
|
1375
|
+
### HTTP request headers
|
|
1376
|
+
|
|
1377
|
+
- **Content-Type**: Not defined
|
|
1378
|
+
- **Accept**: application/json, application/problem+json
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
### HTTP response details
|
|
1382
|
+
| Status code | Description | Response headers |
|
|
1383
|
+
|-------------|-------------|------------------|
|
|
1384
|
+
|**200** | ์นํ
์ ์ก ์ด๋ ฅ. | * ETag - ๋ฆฌ์์ค ์ง๋ฌธ(weak). ๋ค์ ์์ฒญ์ `If-None-Match` ํค๋๋ก ๋๋ณด๋ด๋ฉด ๋ด์ฉ์ด ๊ทธ๋๋ก์ผ ๋ `304 Not Modified` ๋ฅผ ๋ณธ๋ฌธ ์์ด ๋ฐ์ต๋๋ค. <br> |
|
|
1385
|
+
|**400** | ์ฟผ๋ฆฌ/๋ณธ๋ฌธ ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`) โ ์ํ ์ด๊ณผ(`bidRefs` 101๊ฑด ๋ฑ), ๊ฐ ํ์ ์๋ฐ, ์ ์ ์๋ `cursor` ๋ฑ. | - |
|
|
1386
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
1387
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
1388
|
+
|**404** | ๋์์ ์ฐพ์ ์ ์์ต๋๋ค(`type: โฆ/upstream-not-found`). | - |
|
|
1389
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
1390
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
1391
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
1392
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
1393
|
+
|
|
1394
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1395
|
+
|
|
1396
|
+
# **listWebhookEndpoints**
|
|
1397
|
+
> ListWebhookEndpoints200Response listWebhookEndpoints()
|
|
1398
|
+
|
|
1399
|
+
์ด API ํค๊ฐ ๋ฑ๋กํ ์นํ
๊ตฌ๋
์ ๋ชจ๋ ์กฐํํฉ๋๋ค. **ํธ์ถ ์์ :** ์ฐ๋ ์ํ๋ฅผ ์ ๊ฒํ ๋, ๋๋ ๋ฐ์ก์ด ๋ฉ์ถ ์ด์ (`status`ยท`consecutiveFailures`)๋ฅผ ํ์ธํ ๋. ์๋ช
์ํฌ๋ฆฟ์ ์ฌ๊ธฐ์ ์ค๋ฆฌ์ง ์์ต๋๋ค. **ํ์ ์ค์ฝํ:** `webhooks:read` ### ์๋ช
๊ฒ์ฆ (ํ์) ์๋ช
์ **[Standard Webhooks](https://www.standardwebhooks.com)** ๊ท์ฝ์ ๊ทธ๋๋ก ๋ฐ๋ฆ
๋๋ค. ์ง์ ๊ตฌํํ์ง ๋ง๊ณ ๊ฐ ์ธ์ด์ `standardwebhooks` ๋ผ์ด๋ธ๋ฌ๋ฆฌ์ ๋ฑ๋ก ์ ๋ฐ์ ์ํฌ๋ฆฟ (`whsec_โฆ`)์ ๊ทธ๋๋ก ๋๊ธฐ์ธ์ โ ๊ทธ๊ฒ์ด ์ด ํ์์ ์ฐ๋ ์ด์ ์
๋๋ค. ```java // Java Webhook webhook = new Webhook(secret); // secret = \"whsec_โฆ\" webhook.verify(rawBody, headers); // ์คํจํ๋ฉด ์์ธ ``` ```ts // Node / TypeScript import { Webhook } from \'standardwebhooks\'; new Webhook(secret).verify(rawBody, headers); ``` ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ์ธ ์ ์๋ค๋ฉด ๋ฐ์ก ์์ฒญ์ ์ค๋ฆฌ๋ ํค๋๋ ์
์
๋๋ค. ``` webhook-id: evt_01J8Z7Q3K9 webhook-timestamp: 1774915200 webhook-signature: v1,K5oZfzN95Z9UVu1EsfQmfVNQhnkZ2pj9o9NDN/H/pI4= ``` 1. ์ํฌ๋ฆฟ์์ `whsec_` ์ ๋์ด๋ฅผ ๋ผ๊ณ **base64 ๋์ฝ๋**ํฉ๋๋ค โ ๊ทธ ๋ฐ์ดํธ๊ฐ HMAC ํค์
๋๋ค (์ํฌ๋ฆฟ ๋ฌธ์์ด ์์ฒด๊ฐ ์๋๋๋ค). 2. `\"${webhook-id}.${webhook-timestamp}.${๋ณธ๋ฌธ ์๋ฌธ}\"` ์ ๋ง๋ญ๋๋ค. **๋ณธ๋ฌธ์ ํ์ฑ ์ ์๋ฌธ ๋ฐ์ดํธ**์ฌ์ผ ํฉ๋๋ค โ JSON ์ ๋ค์ ์ง๋ ฌํํ๋ฉด ๊ณต๋ฐฑยทํค ์์๊ฐ ๋ฌ๋ผ์ ธ ์๋ช
์ด ๋ง์ง ์์ต๋๋ค. 3. HMAC-SHA256 ์ ๊ณ์ฐํด **base64** ๋ก ์ธ์ฝ๋ฉํ๊ณ , `webhook-signature` ์ `v1,` ๋ค ๊ฐ๊ณผ ๋น๊ตํฉ๋๋ค. ๋น๊ต๋ **์์ ์๊ฐ** ํจ์๋ฅผ ์ฐ์ธ์(Node `crypto.timingSafeEqual`, Java `MessageDigest.isEqual`). 4. `webhook-timestamp` ๊ฐ ํ์ฌ ์๊ฐ์์ **5๋ถ** ์ด์ ์ง๋ฌ์ผ๋ฉด ๊ฑฐ์ ํ์ธ์(์ฌ์ ์ก ๊ณต๊ฒฉ ๋ฐฉ์ด). `webhook-signature` ๋ ๊ณต๋ฐฑ์ผ๋ก ๊ตฌ๋ถ๋ **์ฌ๋ฌ ์๋ช
**์ ์ค์ ์ ์๋ ํ์์
๋๋ค(ํค ํ์ ์ฉ). ์ง๊ธ์ ํญ์ ํ๋์ง๋ง, ๊ฒ์ฆ๊ธฐ๋ ๋ชฉ๋ก์ผ๋ก ์ฝ๊ณ **ํ๋๋ผ๋ ๋ง์ผ๋ฉด ํต๊ณผ**ํ๋๋ก ์ง์ธ์. ### ์ค๋ณต ์ ๊ฑฐ `webhook-id` ํค๋๊ฐ ์ด๋ฒคํธ ์๋ณ์์
๋๋ค. **์ฌ์๋์๋ ๊ฐ์ ๊ฐ์ด ์ต๋๋ค** โ ์ด๋ฏธ ์ฒ๋ฆฌํ ๊ฐ์ด๋ฉด ๋ฌด์ํ์ธ์. ๊ฐ์ ์ด๋ฒคํธ๋ฅผ ๋ ๋ฒ ๋ฐ๋ ๊ฒ์ ์ ์ ๋์์ด๋ฉฐ, ์ค๋ณต ์ ๊ฑฐ๋ ์์ ์ธก ์ฑ
์์
๋๋ค. ํธ์๋ฅผ ์ํด `webhook-event-type` ํค๋์ ์ด๋ฒคํธ ํ์
(๋ณธ๋ฌธ `type` ๊ณผ ๊ฐ์ ๊ฐ)๋ ์ค๋ฆฝ๋๋ค โ ๋ณธ๋ฌธ์ ํ์ฑํ๊ธฐ ์ ์ ๊ด์ฌ ์๋ ํ์
์ ๋ฒ๋ฆด ์ ์์ต๋๋ค. ํ์ค์๋ ์๋ ํ์ฅ์ด๋ผ ๊ฒ์ฆ ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ ์ด ํค๋๋ฅผ ๋ฌด์ํฉ๋๋ค. ### ์๋ต๊ณผ ์ฌ์๋ 2xx ๋ฅผ ๋๋ ค์ฃผ๋ฉด ์ฑ๊ณต์
๋๋ค. ๊ทธ ์ธ(๋๋ ๋ฌด์๋ต)๋ ์คํจ๋ก ๋ณด๊ณ ์ต๋ 7ํ ์ฌ์๋ํฉ๋๋ค โ ๊ฐ๊ฒฉ์ 10์ด โ 1๋ถ โ 5๋ถ โ 30๋ถ โ 2์๊ฐ โ 6์๊ฐ โ 24์๊ฐ ์
๋๋ค. ์ฒ๋ฆฌ ์๊ฐ์ด ๊ธธ๋ฉด ๋จผ์ 2xx ๋ฅผ ๋๋ ค์ฃผ๊ณ ๋น๋๊ธฐ๋ก ์ฒ๋ฆฌํ์ธ์. ์ฐ์ ์คํจ๊ฐ 20ํ์ ๋ฟ์ผ๋ฉด ๊ตฌ๋
์ด ์๋์ผ๋ก `DISABLED` ๋ก ๋ด๋ ค๊ฐ๊ณ ๋ฐ์ก์ด ๋ฉ์ถฅ๋๋ค. ์์ ์ธก์ ๊ณ ์น ๋ค `PATCH /v2/webhook-endpoints/{endpointId}` ์ `{\"status\":\"ACTIVE\"}` ๋ก ๋์ด๋ฆฌ์ธ์. ### ๊ตฌ๋
๊ฐ๋ฅํ ์ด๋ฒคํธ `bid.closed` ยท `bid.awarded` ยท `bid.failed` ยท `bid.canceled` ยท `bid.award_reverted` `ping` ์ ์ฐ๊ฒฐ ํ์ธ ์ ์ฉ์ด๋ผ ๊ตฌ๋
ํ ์ ์์ต๋๋ค โ ํ
์คํธ ๋ฐ์ก ๊ฒฝ๋ก์์๋ง ๋๊ฐ๋๋ค. ### ๋์น ์ด๋ฒคํธ ํ์ธ `GET /v2/webhook-deliveries` ๊ฐ ๋ฐ์ก ์๋ ์ด๋ ฅ(๋ณธ๋ฌธยท์๋ต ์ํยท๋ค์ ์ฌ์๋ ์๊ฐ)์ ๋๋ ค์ค๋๋ค. ์์ ์ธก ์ฅ์ ๊ตฌ๊ฐ์ ๋ฉ์ธ ๋ ์ด ์๋ํฌ์ธํธ๋ฅผ ํด๋ง ๋์ฒด ๊ฒฝ๋ก๋ก ์ฐ์ธ์.
|
|
1400
|
+
|
|
1401
|
+
### Example
|
|
1402
|
+
|
|
1403
|
+
```typescript
|
|
1404
|
+
import {
|
|
1405
|
+
PartnerApiApi,
|
|
1406
|
+
Configuration
|
|
1407
|
+
} from '@cmarket/partner-sdk';
|
|
1408
|
+
|
|
1409
|
+
const configuration = new Configuration();
|
|
1410
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1411
|
+
|
|
1412
|
+
const { status, data } = await apiInstance.listWebhookEndpoints();
|
|
1413
|
+
```
|
|
1414
|
+
|
|
1415
|
+
### Parameters
|
|
1416
|
+
This endpoint does not have any parameters.
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
### Return type
|
|
1420
|
+
|
|
1421
|
+
**ListWebhookEndpoints200Response**
|
|
1422
|
+
|
|
1423
|
+
### Authorization
|
|
1424
|
+
|
|
1425
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1426
|
+
|
|
1427
|
+
### HTTP request headers
|
|
1428
|
+
|
|
1429
|
+
- **Content-Type**: Not defined
|
|
1430
|
+
- **Accept**: application/json, application/problem+json
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
### HTTP response details
|
|
1434
|
+
| Status code | Description | Response headers |
|
|
1435
|
+
|-------------|-------------|------------------|
|
|
1436
|
+
|**200** | ์นํ
๊ตฌ๋
๋ชฉ๋ก. | * ETag - ๋ฆฌ์์ค ์ง๋ฌธ(weak). ๋ค์ ์์ฒญ์ `If-None-Match` ํค๋๋ก ๋๋ณด๋ด๋ฉด ๋ด์ฉ์ด ๊ทธ๋๋ก์ผ ๋ `304 Not Modified` ๋ฅผ ๋ณธ๋ฌธ ์์ด ๋ฐ์ต๋๋ค. <br> |
|
|
1437
|
+
|**400** | ์ฟผ๋ฆฌ/๋ณธ๋ฌธ ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`) โ ์ํ ์ด๊ณผ(`bidRefs` 101๊ฑด ๋ฑ), ๊ฐ ํ์ ์๋ฐ, ์ ์ ์๋ `cursor` ๋ฑ. | - |
|
|
1438
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
1439
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
1440
|
+
|**404** | ๋์์ ์ฐพ์ ์ ์์ต๋๋ค(`type: โฆ/upstream-not-found`). | - |
|
|
1441
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
1442
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
1443
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
1444
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
1445
|
+
|
|
1446
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1447
|
+
|
|
1129
1448
|
# **markBidFailed**
|
|
1130
1449
|
> MarkBidFailed201Response markBidFailed(markBidFailedRequestDto)
|
|
1131
1450
|
|
|
@@ -1522,6 +1841,132 @@ const { status, data } = await apiInstance.revertAward(
|
|
|
1522
1841
|
|
|
1523
1842
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1524
1843
|
|
|
1844
|
+
# **rotateWebhookSecret**
|
|
1845
|
+
> CreateWebhookEndpoint201Response rotateWebhookSecret()
|
|
1846
|
+
|
|
1847
|
+
์๋ช
์ํฌ๋ฆฟ์ ์๋ก ๋ฐ๊ธํฉ๋๋ค. ์๋ต์ `secretVersion` ์ด 1 ์ฌ๋ผ๊ฐ๋๋ค. **ํธ์ถ ์์ :** ์ํฌ๋ฆฟ์ ๋ถ์คํ๊ฑฐ๋ ์ ์ถ์ด ์์ฌ๋ ๋, ๋๋ ์ฃผ๊ธฐ์ ๊ต์ฒด ์ ์ฑ
์ด ์์ ๋. **์ ์ํฌ๋ฆฟ์ ์ด ์๋ต์์ ํ ๋ฒ๋ง ๋๊ฐ๋๋ค.** ์กฐํ๋ก ๋ค์ ๋ฐ์ ์ ์์ต๋๋ค. **์ ์ํฌ๋ฆฟ์ ์ฆ์ ๋ฌดํจ์
๋๋ค.** ์ ์ ๊ธฐ๊ฐ์ด ์์ผ๋ฏ๋ก, ์์ ์ธก์ด ์ ๊ฐ์ ๋ฐ์ํ๊ธฐ ์ ์ ๋์ฐฉํ ์ด๋ฒคํธ๋ ์๋ช
๊ฒ์ฆ์ ์คํจํฉ๋๋ค. ๋ฐฐํฌ ์์๋ฅผ ์ด๋ ๊ฒ ์ก์ผ์ธ์ โ โ ์์ ์ธก์ด ์ ๊ฐ๊ณผ ์ ๊ฐ์ **๋ ๋ค** ๋ฐ์๋ค์ด๋๋ก ๋ฐฐํฌ โ โก ์ด ์๋ํฌ์ธํธ ํธ์ถ โ โข ์๋ต์ ์ ๊ฐ์ ๋ฐ์ โ โฃ ์ ๊ฐ ์ ๊ฑฐ. ๊ฒ์ฆ ์คํจ๋ก non-2xx ๋ฅผ ๋๋ ค์ฃผ๋ฉด ์คํจ๋ก ์ง๊ณ๋์ด 20ํ ์ฐ์ ์ ๊ตฌ๋
์ด ์ค์ง๋ฉ๋๋ค. **ํ์ ์ค์ฝํ:** `webhooks:write` **๋ฉฑ๋ฑ์ฑ:** `Idempotency-Key` ํค๋ ํ์. ๊ฐ์ ํค๋ก ์ฌ์ ์กํ๋ฉด **์๋ก ๋ฐ๊ธํ์ง ์๊ณ ** ์ฒ์ ๋ฐ๊ธํ ๊ฐ์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค(24์๊ฐ) โ ๋คํธ์ํฌ ์ค๋ฅ๋ก ์๋ต์ ๋์ณค์ ๋ ๊ฐ์ ํค๋ก ๋ค์ ๋ถ๋ฅด์ธ์.
|
|
1848
|
+
|
|
1849
|
+
### Example
|
|
1850
|
+
|
|
1851
|
+
```typescript
|
|
1852
|
+
import {
|
|
1853
|
+
PartnerApiApi,
|
|
1854
|
+
Configuration
|
|
1855
|
+
} from '@cmarket/partner-sdk';
|
|
1856
|
+
|
|
1857
|
+
const configuration = new Configuration();
|
|
1858
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1859
|
+
|
|
1860
|
+
let endpointId: string; //๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). (default to undefined)
|
|
1861
|
+
let idempotencyKey: string; //๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. (default to undefined)
|
|
1862
|
+
|
|
1863
|
+
const { status, data } = await apiInstance.rotateWebhookSecret(
|
|
1864
|
+
endpointId,
|
|
1865
|
+
idempotencyKey
|
|
1866
|
+
);
|
|
1867
|
+
```
|
|
1868
|
+
|
|
1869
|
+
### Parameters
|
|
1870
|
+
|
|
1871
|
+
|Name | Type | Description | Notes|
|
|
1872
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1873
|
+
| **endpointId** | [**string**] | ๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). | defaults to undefined|
|
|
1874
|
+
| **idempotencyKey** | [**string**] | ๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. | defaults to undefined|
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
### Return type
|
|
1878
|
+
|
|
1879
|
+
**CreateWebhookEndpoint201Response**
|
|
1880
|
+
|
|
1881
|
+
### Authorization
|
|
1882
|
+
|
|
1883
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1884
|
+
|
|
1885
|
+
### HTTP request headers
|
|
1886
|
+
|
|
1887
|
+
- **Content-Type**: Not defined
|
|
1888
|
+
- **Accept**: application/json, application/problem+json
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
### HTTP response details
|
|
1892
|
+
| Status code | Description | Response headers |
|
|
1893
|
+
|-------------|-------------|------------------|
|
|
1894
|
+
|**200** | ์ํฌ๋ฆฟ ์ฌ๋ฐ๊ธ ์๋ฃ. `secret` ์ ์ด ์๋ต์๋ง ์ค๋ฆฝ๋๋ค. | - |
|
|
1895
|
+
|**400** | ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`), Idempotency-Key ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ(`โฆ/idempotency-key-required`, `โฆ/idempotency-key-invalid`), ๋๋ ์์ฒญ ๋ด์ฉ์ด ์ ํจํ์ง ์์(`โฆ/upstream-invalid-input`). | - |
|
|
1896
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
1897
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
1898
|
+
|**409** | ์ ์์ฒญ์ด ์์ง ์ฒ๋ฆฌ ์ค์ธ ์ํ์์ ๊ฐ์ Idempotency-Key ์ฌ์ ์ก(`type: โฆ/idempotency-key-conflict` โ ์ ์ ๋ค ๊ฐ์ ํค๋ก ์ฌ์๋ํ๋ฉด ๊ฒฐ๊ณผ๋ฅผ ๋ฐ๋๋ค) ๋๋ ํ์ฌ ์ํ์ ์ถฉ๋ํ๋ ์์ฒญ(`โฆ/upstream-conflict`). | - |
|
|
1899
|
+
|**422** | ๋์ผ Idempotency-Key ๋ฅผ **๋ค๋ฅธ body** ๋ก ์ฌ์ ์ก(`type: โฆ/idempotency-key-reused`). ์ฌ์๋ํด๋ ๋์ผ ์คํจ โ ์ ํค๋ฅผ ์ฐ๊ฑฐ๋ body ๋ฅผ ์๋๋๋ก ๋๋๋ ค์ผ ํ๋ค. ํ์์ ๋ง์ง๋ง ๋ด์ฉ์ ์ฒ๋ฆฌํ ์ ์๋ ์์ฒญ(`โฆ/upstream-unprocessable`)๋ ์ด ์ํ๋ค. | - |
|
|
1900
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
1901
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
1902
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
1903
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
1904
|
+
|
|
1905
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1906
|
+
|
|
1907
|
+
# **sendWebhookTestEvent**
|
|
1908
|
+
> SendWebhookTestEvent200Response sendWebhookTestEvent()
|
|
1909
|
+
|
|
1910
|
+
๋ฑ๋ก๋ ์ฃผ์๋ก `ping` ์ด๋ฒคํธ๋ฅผ ์ฆ์ 1ํ ๋ณด๋ด๊ณ ๊ทธ ๊ฒฐ๊ณผ๋ฅผ ๋๋ ค์ค๋๋ค. **ํธ์ถ ์์ :** ๊ตฌ๋
์ ๋ฑ๋กํ ์งํ, ์์ ์ฃผ์๋ฅผ ๋ฐ๊พผ ์งํ, ๋ฐฉํ๋ฒฝยท์ธ์ฆ์๋ฅผ ์๋ณธ ๋ค. **์๋ต์ ๋ฐ์ก ๊ฒฐ๊ณผ์ด์ง ์์ฒญ ์คํจ๊ฐ ์๋๋๋ค.** ์์ ์ธก์ด ๋ฐ์ง ๋ชปํด๋ HTTP `200` ์ `delivered: false` ๋ก ์ต๋๋ค โ `responseStatus`(์์ ์ธก ์ํ)์ `error`(์ฐ๊ฒฐ ๊ฑฐ๋ถยทํ์์์ยท TLS ์ค๋ฅ)๋ฅผ ๋ณด๊ณ ์์ธ์ ์ขํ์ธ์. ์ด ๋ฐ์ก์๋ ์ค์ ์ด๋ฒคํธ์ **๋๊ฐ์ ์๋ช
ํค๋**๊ฐ ์ค๋ฆฌ๋ฏ๋ก ๊ฒ์ฆ ์ฝ๋๋ฅผ ๊ทธ๋๋ก ์ํํ ์ ์์ต๋๋ค. `ping` ์ ๊ตฌ๋
๋ชฉ๋ก์ ๋ฃ์ ์ ์๋ ํ์
์ด๋, ์์ ์ธก์ด ๋ชจ๋ฅด๋ `eventType` ์ ๋ง๋๋ฉด ๋ฒ๋ฆฌ๋๋ก ์ง์ฌ ์๋ค๋ฉด ์ด ํ์ธ๋ง ์คํจํ ์ ์์ต๋๋ค. **ํ์ ์ค์ฝํ:** `webhooks:write` **๋ฉฑ๋ฑ์ฑ:** `Idempotency-Key` ํค๋ ํ์. ๋ค์ ๋ณด๋ด๋ ค๋ฉด **์ ํค**๋ฅผ ์ฐ์ธ์ โ ๊ฐ์ ํค๋ 24์๊ฐ ๋์ ์ง์ ๊ฒฐ๊ณผ๋ฅผ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค(์ฌ๋ฐ์กํ์ง ์์ต๋๋ค).
|
|
1911
|
+
|
|
1912
|
+
### Example
|
|
1913
|
+
|
|
1914
|
+
```typescript
|
|
1915
|
+
import {
|
|
1916
|
+
PartnerApiApi,
|
|
1917
|
+
Configuration
|
|
1918
|
+
} from '@cmarket/partner-sdk';
|
|
1919
|
+
|
|
1920
|
+
const configuration = new Configuration();
|
|
1921
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
1922
|
+
|
|
1923
|
+
let endpointId: string; //๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). (default to undefined)
|
|
1924
|
+
let idempotencyKey: string; //๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. (default to undefined)
|
|
1925
|
+
|
|
1926
|
+
const { status, data } = await apiInstance.sendWebhookTestEvent(
|
|
1927
|
+
endpointId,
|
|
1928
|
+
idempotencyKey
|
|
1929
|
+
);
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
### Parameters
|
|
1933
|
+
|
|
1934
|
+
|Name | Type | Description | Notes|
|
|
1935
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1936
|
+
| **endpointId** | [**string**] | ๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). | defaults to undefined|
|
|
1937
|
+
| **idempotencyKey** | [**string**] | ๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. | defaults to undefined|
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
### Return type
|
|
1941
|
+
|
|
1942
|
+
**SendWebhookTestEvent200Response**
|
|
1943
|
+
|
|
1944
|
+
### Authorization
|
|
1945
|
+
|
|
1946
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
1947
|
+
|
|
1948
|
+
### HTTP request headers
|
|
1949
|
+
|
|
1950
|
+
- **Content-Type**: Not defined
|
|
1951
|
+
- **Accept**: application/json, application/problem+json
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
### HTTP response details
|
|
1955
|
+
| Status code | Description | Response headers |
|
|
1956
|
+
|-------------|-------------|------------------|
|
|
1957
|
+
|**200** | ์ฐ๊ฒฐ ํ์ธ ๋ฐ์ก ๊ฒฐ๊ณผ. | - |
|
|
1958
|
+
|**400** | ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`), Idempotency-Key ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ(`โฆ/idempotency-key-required`, `โฆ/idempotency-key-invalid`), ๋๋ ์์ฒญ ๋ด์ฉ์ด ์ ํจํ์ง ์์(`โฆ/upstream-invalid-input`). | - |
|
|
1959
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
1960
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
1961
|
+
|**409** | ์ ์์ฒญ์ด ์์ง ์ฒ๋ฆฌ ์ค์ธ ์ํ์์ ๊ฐ์ Idempotency-Key ์ฌ์ ์ก(`type: โฆ/idempotency-key-conflict` โ ์ ์ ๋ค ๊ฐ์ ํค๋ก ์ฌ์๋ํ๋ฉด ๊ฒฐ๊ณผ๋ฅผ ๋ฐ๋๋ค) ๋๋ ํ์ฌ ์ํ์ ์ถฉ๋ํ๋ ์์ฒญ(`โฆ/upstream-conflict`). | - |
|
|
1962
|
+
|**422** | ๋์ผ Idempotency-Key ๋ฅผ **๋ค๋ฅธ body** ๋ก ์ฌ์ ์ก(`type: โฆ/idempotency-key-reused`). ์ฌ์๋ํด๋ ๋์ผ ์คํจ โ ์ ํค๋ฅผ ์ฐ๊ฑฐ๋ body ๋ฅผ ์๋๋๋ก ๋๋๋ ค์ผ ํ๋ค. ํ์์ ๋ง์ง๋ง ๋ด์ฉ์ ์ฒ๋ฆฌํ ์ ์๋ ์์ฒญ(`โฆ/upstream-unprocessable`)๋ ์ด ์ํ๋ค. | - |
|
|
1963
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
1964
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
1965
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
1966
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
1967
|
+
|
|
1968
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1969
|
+
|
|
1525
1970
|
# **submitNegotiationScores**
|
|
1526
1971
|
> SubmitNegotiationScores201Response submitNegotiationScores(submitNegotiationScoresRequestDto)
|
|
1527
1972
|
|
|
@@ -1661,6 +2106,78 @@ const { status, data } = await apiInstance.updateBid(
|
|
|
1661
2106
|
|
|
1662
2107
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1663
2108
|
|
|
2109
|
+
# **updateWebhookEndpoint**
|
|
2110
|
+
> GetWebhookEndpoint200Response updateWebhookEndpoint(updateWebhookEndpointRequestDto)
|
|
2111
|
+
|
|
2112
|
+
์์ ์ฃผ์ยท๊ตฌ๋
์ด๋ฒคํธยท์ํ๋ฅผ ์์ ํฉ๋๋ค. ๋ณด๋ธ ํ๋๋ง ๋ฐ๋๋๋ค. **ํธ์ถ ์์ :** ์์ ์ฃผ์๊ฐ ๋ฐ๋์์ ๋, ๊ตฌ๋
์ด๋ฒคํธ๋ฅผ ๋๋ฆฌ๊ฑฐ๋ ์ค์ผ ๋, ์ฐ์ ์คํจ๋ก ์๋ ์ค์ง๋ ๊ตฌ๋
์ ๊ณ ์น ๋ค ๋์ด๋ฆด ๋(`{\"status\":\"ACTIVE\"}`). **`eventTypes` ๋ ์นํ์
๋๋ค** โ ๋ณด๋ธ ๋ชฉ๋ก์ด ๊ณง ์ ๊ตฌ๋
๋ชฉ๋ก์
๋๋ค. ํ๋๋ฅผ ๋ํ๋ ค๋ฉด ๊ธฐ์กด ๋ชฉ๋ก์ ๋ํ **์ ์ฒด**๋ฅผ ๋ณด๋ด์ธ์. **`If-Match` ๊ฐ ํ์์
๋๋ค.** ๋จผ์ `GET /v2/webhook-endpoints/{endpointId}` ๋ก ํ์ฌ `ETag` ๋ฅผ ๋ฐ์ ๊ทธ๋๋ก ์ค์ด ๋ณด๋ด์ธ์. ์ด ํค๋๊ฐ ์์ผ๋ฉด ๋ ์์ฒญ์ด ์์๊ฑฐ๋ ๋ค์๊ฑฐ๋ ํ๋ฉฐ ๋จผ์ ํ ์์ ์ ์กฐ์ฉํ ๋ฎ์ด์๋๋ค. - `428` โ ํค๋๋ฅผ ๋นผ๋จน์์ต๋๋ค. ์กฐํ ํ `ETag` ๋ฅผ ์ค์ด ์ฌ์๋ํ์ธ์. - `412` โ ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ต๋๋ค. ๋ค์ ์กฐํํด ์ต์ `ETag` ๋ก ์ฌ์๋ํ์ธ์. ์๋ฌด๊ฒ๋ ์์ ๋์ง ์์์ต๋๋ค. **์ํฌ๋ฆฟ์ ์ด ๊ฒฝ๋ก๋ก ๋ฐ๋์ง ์์ต๋๋ค** โ ์ฌ๋ฐ๊ธ์ `rotate-secret` ์
๋๋ค. **ํ์ ์ค์ฝํ:** `webhooks:write` **๋ฉฑ๋ฑ์ฑ:** `Idempotency-Key` ํค๋ ํ์.
|
|
2113
|
+
|
|
2114
|
+
### Example
|
|
2115
|
+
|
|
2116
|
+
```typescript
|
|
2117
|
+
import {
|
|
2118
|
+
PartnerApiApi,
|
|
2119
|
+
Configuration,
|
|
2120
|
+
UpdateWebhookEndpointRequestDto
|
|
2121
|
+
} from '@cmarket/partner-sdk';
|
|
2122
|
+
|
|
2123
|
+
const configuration = new Configuration();
|
|
2124
|
+
const apiInstance = new PartnerApiApi(configuration);
|
|
2125
|
+
|
|
2126
|
+
let endpointId: string; //๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). (default to undefined)
|
|
2127
|
+
let ifMatch: string; //์ง์ ์กฐํ ์๋ต์ `ETag` ๊ฐ. ๋๋ฝํ๋ฉด 428, ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ผ๋ฉด 412 ๋ก ๊ฑฐ์ ๋๋ฉฐ ์๋ฌด๊ฒ๋ ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. (default to undefined)
|
|
2128
|
+
let idempotencyKey: string; //๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. (default to undefined)
|
|
2129
|
+
let updateWebhookEndpointRequestDto: UpdateWebhookEndpointRequestDto; //
|
|
2130
|
+
|
|
2131
|
+
const { status, data } = await apiInstance.updateWebhookEndpoint(
|
|
2132
|
+
endpointId,
|
|
2133
|
+
ifMatch,
|
|
2134
|
+
idempotencyKey,
|
|
2135
|
+
updateWebhookEndpointRequestDto
|
|
2136
|
+
);
|
|
2137
|
+
```
|
|
2138
|
+
|
|
2139
|
+
### Parameters
|
|
2140
|
+
|
|
2141
|
+
|Name | Type | Description | Notes|
|
|
2142
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2143
|
+
| **updateWebhookEndpointRequestDto** | **UpdateWebhookEndpointRequestDto**| | |
|
|
2144
|
+
| **endpointId** | [**string**] | ๊ตฌ๋
์๋ณ์(๋ฑ๋ก ์๋ต์ `endpointId`). | defaults to undefined|
|
|
2145
|
+
| **ifMatch** | [**string**] | ์ง์ ์กฐํ ์๋ต์ `ETag` ๊ฐ. ๋๋ฝํ๋ฉด 428, ๊ทธ ์ฌ์ด ๊ตฌ๋
์ด ๋ฐ๋์์ผ๋ฉด 412 ๋ก ๊ฑฐ์ ๋๋ฉฐ ์๋ฌด๊ฒ๋ ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. | defaults to undefined|
|
|
2146
|
+
| **idempotencyKey** | [**string**] | ๋ฉฑ๋ฑ์ฑ ํค(1~255์, `[A-Za-z0-9_-]`). **์ฌ์๋ํ ๋ ์ฒ์๊ณผ ๊ฐ์ ํค๋ฅผ ๋ค์ ๋ณด๋ด์ผ** ์ค๋ณต ์์ฑ์ด ๋งํ๋๋ค โ ํ์์์ยท๋คํธ์ํฌ ์ค๋ฅ๋ก ๋ค์ ๋ถ๋ฅด๋ฉด์ ์ ํค๋ฅผ ๋ง๋ค๋ฉด ๋ณ๊ฐ ์์ฒญ์ผ๋ก ์ฒ๋ฆฌ๋ฉ๋๋ค. ๊ทธ๋์ ํค๋ UUID v4 ๋ฅผ ๋ง๋ค์ด **์ฐ๋ ์์คํ
์์ฅ์ ์ ์ฅ**ํ๊ฑฐ๋, ์์ฒญ ๋ด์ฉ์์ ๊ฒฐ์ ์ ์ผ๋ก ํ์(์: `bid-create-{๊ตฌ๋งค๋ฒํธ}`)ํด ์ฌ์๋๊ฐ ๊ฐ์ ๊ฐ์ ์ฌํํ๋๋ก ํ์ธ์. ๊ฐ์ ํค + ๊ฐ์ body ๋ 24์๊ฐ ๋์ ์บ์๋ ์๋ต์ ๊ทธ๋๋ก ๋๋ ค์ค๋๋ค. | defaults to undefined|
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
### Return type
|
|
2150
|
+
|
|
2151
|
+
**GetWebhookEndpoint200Response**
|
|
2152
|
+
|
|
2153
|
+
### Authorization
|
|
2154
|
+
|
|
2155
|
+
[partner-oauth2](../README.md#partner-oauth2)
|
|
2156
|
+
|
|
2157
|
+
### HTTP request headers
|
|
2158
|
+
|
|
2159
|
+
- **Content-Type**: application/json
|
|
2160
|
+
- **Accept**: application/json, application/problem+json
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
### HTTP response details
|
|
2164
|
+
| Status code | Description | Response headers |
|
|
2165
|
+
|-------------|-------------|------------------|
|
|
2166
|
+
|**200** | ์์ ๋ ์นํ
๊ตฌ๋
. | - |
|
|
2167
|
+
|**400** | ์
๋ ฅ ๊ฒ์ฆ ์คํจ(`type: โฆ/validation-failed`), Idempotency-Key ํค๋ ๋๋ฝ/ํ์ ์ค๋ฅ(`โฆ/idempotency-key-required`, `โฆ/idempotency-key-invalid`), ๋๋ ์์ฒญ ๋ด์ฉ์ด ์ ํจํ์ง ์์(`โฆ/upstream-invalid-input`). | - |
|
|
2168
|
+
|**401** | Bearer ํ ํฐ ์์(`type: โฆ/missing-bearer-token`) ๋๋ ๋ง๋ฃ/์๋ณ์กฐ/ํ๊ธฐ(`โฆ/invalid-token`). | - |
|
|
2169
|
+
|**403** | ํค ๋ฏธ๋ฐ์ธ๋ฉ(`type: โฆ/unbound-partner-key`), ํด๋ผ์ด์ธํธ IP ์ฐจ๋จ(`โฆ/ip-not-allowed`), ์ค์ฝํ ๋ถ์กฑ(`โฆ/insufficient-scope`), buyerId ๊ฐ ํค์ ๋ํ ๋ฒ์ ๋ฐ(`โฆ/buyer-scope-mismatch` โ ์๋๋ฐ์ค ํค์ ๋ฒ์ ์๋ฐ๋ ์ด slug), ๋๋ ์์ฒญ ๊ถํ ์์(`โฆ/upstream-forbidden`). | - |
|
|
2170
|
+
|**409** | ์ ์์ฒญ์ด ์์ง ์ฒ๋ฆฌ ์ค์ธ ์ํ์์ ๊ฐ์ Idempotency-Key ์ฌ์ ์ก(`type: โฆ/idempotency-key-conflict` โ ์ ์ ๋ค ๊ฐ์ ํค๋ก ์ฌ์๋ํ๋ฉด ๊ฒฐ๊ณผ๋ฅผ ๋ฐ๋๋ค) ๋๋ ํ์ฌ ์ํ์ ์ถฉ๋ํ๋ ์์ฒญ(`โฆ/upstream-conflict`). | - |
|
|
2171
|
+
|**412** | `If-Match` ์ง๋ฌธ์ด ํ์ฌ ๋ฆฌ์์ค์ ๋ค๋ฆ
๋๋ค(`type: โฆ/precondition-failed`). ๊ทธ ์ฌ์ด ๋ค๋ฅธ ์์ฒญ์ด ๋ฆฌ์์ค๋ฅผ ๋ฐ๊ฟจ์ต๋๋ค โ ๋ค์ ์กฐํํด ์ต์ ETag ๋ก ์ฌ์๋ํ์ธ์. | - |
|
|
2172
|
+
|**422** | ๋์ผ Idempotency-Key ๋ฅผ **๋ค๋ฅธ body** ๋ก ์ฌ์ ์ก(`type: โฆ/idempotency-key-reused`). ์ฌ์๋ํด๋ ๋์ผ ์คํจ โ ์ ํค๋ฅผ ์ฐ๊ฑฐ๋ body ๋ฅผ ์๋๋๋ก ๋๋๋ ค์ผ ํ๋ค. ํ์์ ๋ง์ง๋ง ๋ด์ฉ์ ์ฒ๋ฆฌํ ์ ์๋ ์์ฒญ(`โฆ/upstream-unprocessable`)๋ ์ด ์ํ๋ค. | - |
|
|
2173
|
+
|**428** | `If-Match` ํค๋๊ฐ ์์ต๋๋ค(`type: โฆ/if-match-required`). ์์ด๋ฒ๋ฆฐ ๊ฐฑ์ ์ ๋ง๊ธฐ ์ํด ํ์์
๋๋ค. | - |
|
|
2174
|
+
|**429** | rate limit ์ด๊ณผ(`type: โฆ/too-many-requests`) โ ์ ์ญ 60/min per client_id. ๋๊ธฐ ์๊ฐ์ `Retry-After`(์ด)๊ฐ ์ฐ์ ํ๊ณ , ์์ฌ ์ฟผํฐยท์ ์ฑ
์ ํ์ค ํ๋ `RateLimit`/`RateLimit-Policy`(draft-ietf-httpapi-ratelimit-headers)๋ก ๋๊ฐ๋๋ค. ๊ด์ฉ ํค๋ `X-RateLimit-Limit`/`X-RateLimit-Remaining`/`X-RateLimit-Reset` ๋ ํจ๊ป ์ค๋ฆฌ์ง๋ง ํ์ค์ด ์๋๋ฏ๋ก ์ ์ฐ๋์ ํ์ค ํ๋๋ฅผ ์ฝ์ผ์ธ์. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> * RateLimit - ํ์ฌ ์ฐฝ์ ์์ฌ ์ฟผํฐ. ์: `\"default\";r=0;t=42`. <br> * RateLimit-Policy - ์ ์ฉ ์ค์ธ ์ฟผํฐ ์ ์ฑ
. ์: `\"default\";q=60;w=60`. <br> |
|
|
2175
|
+
|**500** | ์๋ฒ ๋ด๋ถ ์ค๋ฅ(`type: โฆ/internal-server-error`). `retryable: true`. | - |
|
|
2176
|
+
|**502** | ์์ฒญ์ ์ฒ๋ฆฌํ์ง ๋ชปํ์ต๋๋ค(`type: โฆ/upstream-rejected`). `retryable: true`. | - |
|
|
2177
|
+
|**503** | ์ผ์์ ์ผ๋ก ์ฒ๋ฆฌํ ์ ์์ต๋๋ค(`type: โฆ/service-unavailable`). `Retry-After` ํค๋ ์ฐธ์กฐ. `retryable: true`. | * Retry-After - ์ฌ์๋๊น์ง ๋๊ธฐํ ์ด. <br> |
|
|
2178
|
+
|
|
2179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2180
|
+
|
|
1664
2181
|
# **uploadFile**
|
|
1665
2182
|
> UploadFile201Response uploadFile(uploadFileRequestDto)
|
|
1666
2183
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PartnerWebhookDeliveryStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Pending` (value: `'PENDING'`)
|
|
7
|
+
|
|
8
|
+
* `Delivered` (value: `'DELIVERED'`)
|
|
9
|
+
|
|
10
|
+
* `Failed` (value: `'FAILED'`)
|
|
11
|
+
|
|
12
|
+
* `Exhausted` (value: `'EXHAUSTED'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|