@cmarket/partner-sdk 38.2.0 β 38.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -4
- package/api/embed-api.ts +1 -1
- package/api/oauth-api.ts +1 -1
- package/api/partner-api-api.ts +155 -78
- package/api/products-api.ts +15 -8
- package/api/webhooks-api.ts +690 -0
- package/api/well-known-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/embed-api.d.ts +1 -1
- package/dist/api/embed-api.js +1 -1
- package/dist/api/oauth-api.d.ts +1 -1
- package/dist/api/oauth-api.js +1 -1
- package/dist/api/partner-api-api.d.ts +89 -45
- package/dist/api/partner-api-api.js +155 -78
- package/dist/api/products-api.d.ts +9 -5
- package/dist/api/products-api.js +15 -8
- package/dist/api/webhooks-api.d.ts +328 -0
- package/dist/api/webhooks-api.js +675 -0
- package/dist/api/well-known-api.d.ts +1 -1
- package/dist/api/well-known-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/embed-api.d.ts +1 -1
- package/dist/esm/api/embed-api.js +1 -1
- package/dist/esm/api/oauth-api.d.ts +1 -1
- package/dist/esm/api/oauth-api.js +1 -1
- package/dist/esm/api/partner-api-api.d.ts +89 -45
- package/dist/esm/api/partner-api-api.js +155 -78
- package/dist/esm/api/products-api.d.ts +9 -5
- package/dist/esm/api/products-api.js +15 -8
- package/dist/esm/api/webhooks-api.d.ts +328 -0
- package/dist/esm/api/webhooks-api.js +668 -0
- package/dist/esm/api/well-known-api.d.ts +1 -1
- package/dist/esm/api/well-known-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/esm/models/acceptance-result-response-dto.js +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/esm/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/esm/models/acknowledge-products-request-dto.js +1 -1
- package/dist/esm/models/api-catalog-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-dto.js +1 -1
- package/dist/esm/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-entry-dto.js +1 -1
- package/dist/esm/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/esm/models/api-catalog-link-dto.js +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/esm/models/authorization-server-metadata-dto.js +1 -1
- package/dist/esm/models/award-method-public.d.ts +1 -1
- package/dist/esm/models/award-method-public.js +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-registered-v2-response-dto.js +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/esm/models/bid-acceptance-dto.js +1 -1
- package/dist/esm/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/esm/models/bid-attachment-input-dto.js +1 -1
- package/dist/esm/models/bid-bond-dto.d.ts +1 -1
- package/dist/esm/models/bid-bond-dto.js +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-cancelled-response-dto.js +1 -1
- package/dist/esm/models/bid-contact-dto.d.ts +1 -1
- package/dist/esm/models/bid-contact-dto.js +1 -1
- package/dist/esm/models/bid-contacts-dto.d.ts +1 -1
- package/dist/esm/models/bid-contacts-dto.js +1 -1
- package/dist/esm/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-contract-document-dto.js +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-delivery-terms-dto.js +1 -1
- package/dist/esm/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-detail-response-dto.js +1 -1
- package/dist/esm/models/bid-document-dto.d.ts +1 -1
- package/dist/esm/models/bid-document-dto.js +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/esm/models/bid-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-item-dto.js +1 -1
- package/dist/esm/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/esm/models/bid-lifecycle-dto.js +1 -1
- package/dist/esm/models/bid-manager-dto.d.ts +1 -1
- package/dist/esm/models/bid-manager-dto.js +1 -1
- package/dist/esm/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/esm/models/bid-payment-terms-dto.js +1 -1
- package/dist/esm/models/bid-product-dto.d.ts +1 -1
- package/dist/esm/models/bid-product-dto.js +1 -1
- package/dist/esm/models/bid-public-status.d.ts +1 -1
- package/dist/esm/models/bid-public-status.js +1 -1
- package/dist/esm/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-registered-response-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/esm/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-result-participant-dto.js +1 -1
- package/dist/esm/models/bid-results-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-results-response-dto.js +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-participant-dto.js +1 -1
- package/dist/esm/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-settlement-response-dto.js +1 -1
- package/dist/esm/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-statement-response-dto.js +1 -1
- package/dist/esm/models/bid-summary-dto.d.ts +1 -1
- package/dist/esm/models/bid-summary-dto.js +1 -1
- package/dist/esm/models/bid-type-public.d.ts +1 -1
- package/dist/esm/models/bid-type-public.js +1 -1
- package/dist/esm/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/esm/models/bid-updated-response-dto.js +1 -1
- package/dist/esm/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/cancel-bid-request-dto.js +1 -1
- package/dist/esm/models/cancel-bid200-response.d.ts +1 -1
- package/dist/esm/models/cancel-bid200-response.js +1 -1
- package/dist/esm/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/esm/models/card-payment-request-response-dto.js +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-acceptance-request-dto.js +1 -1
- package/dist/esm/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/esm/models/complete-acceptance200-response.js +1 -1
- package/dist/esm/models/complete-invoice200-response.d.ts +1 -1
- package/dist/esm/models/complete-invoice200-response.js +1 -1
- package/dist/esm/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/esm/models/complete-upload-request-dto.js +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/esm/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/esm/models/create-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/create-bid-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-dto.js +1 -1
- package/dist/esm/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/esm/models/create-card-payment-request-dto.js +1 -1
- package/dist/esm/models/create-card-payment200-response.d.ts +1 -1
- package/dist/esm/models/create-card-payment200-response.js +1 -1
- package/dist/esm/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/esm/models/create-embed-launch201-response.js +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/esm/models/create-file-upload-url201-response.js +1 -1
- package/dist/esm/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/esm/models/create-upload-url-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/esm/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/esm/models/delivery-date-type-public.d.ts +1 -1
- package/dist/esm/models/delivery-date-type-public.js +1 -1
- package/dist/esm/models/delivery-method-public.d.ts +1 -1
- package/dist/esm/models/delivery-method-public.js +1 -1
- package/dist/esm/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-request-dto.js +1 -1
- package/dist/esm/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/esm/models/embed-launch-response-dto.js +1 -1
- package/dist/esm/models/excellent-procurement-public.d.ts +1 -1
- package/dist/esm/models/excellent-procurement-public.js +1 -1
- package/dist/esm/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-document-item-dto.js +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-documents-response-dto.js +1 -1
- package/dist/esm/models/external-contract-item-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-item-dto.js +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/esm/models/external-contract-snapshot-dto.js +1 -1
- package/dist/esm/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/esm/models/external-document-inputs-dto.js +1 -1
- package/dist/esm/models/file-meta-response-dto.d.ts +1 -1
- package/dist/esm/models/file-meta-response-dto.js +1 -1
- package/dist/esm/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/esm/models/file-uploaded-response-dto.js +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/esm/models/generated-external-contract-document-dto.js +1 -1
- package/dist/esm/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-settlement200-response.js +1 -1
- package/dist/esm/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/esm/models/get-bid-statement200-response.js +1 -1
- package/dist/esm/models/get-bid200-response.d.ts +1 -1
- package/dist/esm/models/get-bid200-response.js +1 -1
- package/dist/esm/models/get-file-meta200-response.d.ts +1 -1
- package/dist/esm/models/get-file-meta200-response.js +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/esm/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/esm/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/esm/models/green-product-public.d.ts +1 -1
- package/dist/esm/models/green-product-public.js +1 -1
- package/dist/esm/models/health-controller-check200-response.d.ts +1 -1
- package/dist/esm/models/health-controller-check200-response.js +1 -1
- package/dist/esm/models/health-response-dto.d.ts +1 -1
- package/dist/esm/models/health-response-dto.js +1 -1
- package/dist/esm/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/esm/models/hierarchical-region-dto.js +1 -1
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/esm/models/introspect-request-dto.d.ts +1 -1
- package/dist/esm/models/introspect-request-dto.js +1 -1
- package/dist/esm/models/introspection-response-dto.d.ts +1 -1
- package/dist/esm/models/introspection-response-dto.js +1 -1
- package/dist/esm/models/invalid-param-dto.d.ts +1 -1
- package/dist/esm/models/invalid-param-dto.js +1 -1
- package/dist/esm/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-completed-response-dto.js +1 -1
- package/dist/esm/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/esm/models/invoice-split-response-dto.js +1 -1
- package/dist/esm/models/legal-mandatory-public.d.ts +1 -1
- package/dist/esm/models/legal-mandatory-public.js +1 -1
- package/dist/esm/models/list-bid-results200-response.d.ts +1 -1
- package/dist/esm/models/list-bid-results200-response.js +1 -1
- package/dist/esm/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/esm/models/list-bids200-response-meta.js +1 -1
- package/dist/esm/models/list-bids200-response.d.ts +1 -1
- package/dist/esm/models/list-bids200-response.js +1 -1
- package/dist/esm/models/list-products200-response.d.ts +1 -1
- package/dist/esm/models/list-products200-response.js +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/esm/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/esm/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/esm/models/mark-bid-failed201-response.js +1 -1
- package/dist/esm/models/negotiation-score-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-score-dto.js +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/esm/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/esm/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/esm/models/oauth-error-response-dto.js +1 -1
- package/dist/esm/models/on-bid-award-reverted-request.d.ts +16 -0
- package/dist/esm/models/on-bid-award-reverted-request.js +14 -0
- package/dist/esm/models/on-bid-awarded-request.d.ts +16 -0
- package/dist/esm/models/on-bid-awarded-request.js +14 -0
- package/dist/esm/models/on-bid-canceled-request.d.ts +16 -0
- package/dist/esm/models/on-bid-canceled-request.js +14 -0
- package/dist/esm/models/on-bid-closed-request.d.ts +16 -0
- package/dist/esm/models/on-bid-closed-request.js +14 -0
- package/dist/esm/models/on-bid-failed-request.d.ts +16 -0
- package/dist/esm/models/on-bid-failed-request.js +14 -0
- package/dist/esm/models/on-ping-request.d.ts +16 -0
- package/dist/esm/models/on-ping-request.js +14 -0
- package/dist/esm/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-delivery-status.js +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/esm/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/esm/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/esm/models/partner-webhook-event-type.js +1 -1
- package/dist/esm/models/payment-method-public.d.ts +1 -1
- package/dist/esm/models/payment-method-public.js +1 -1
- package/dist/esm/models/preconditions-dto.d.ts +1 -1
- package/dist/esm/models/preconditions-dto.js +1 -1
- package/dist/esm/models/problem-details-dto.d.ts +1 -1
- package/dist/esm/models/problem-details-dto.js +1 -1
- package/dist/esm/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/esm/models/product-receipt-response-dto.js +1 -1
- package/dist/esm/models/product-response-dto.d.ts +1 -1
- package/dist/esm/models/product-response-dto.js +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/esm/models/protected-resource-metadata-dto.js +1 -1
- package/dist/esm/models/register-award-request-dto.d.ts +1 -1
- package/dist/esm/models/register-award-request-dto.js +1 -1
- package/dist/esm/models/register-award201-response.d.ts +1 -1
- package/dist/esm/models/register-award201-response.js +1 -1
- package/dist/esm/models/register-bid201-response.d.ts +1 -1
- package/dist/esm/models/register-bid201-response.js +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/esm/models/register-semo-contract-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/esm/models/request-invoice-split-request-dto.js +1 -1
- package/dist/esm/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/esm/models/request-invoice-split200-response.js +1 -1
- package/dist/esm/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-input-dto.js +1 -1
- package/dist/esm/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/esm/models/retiree-roster-row-dto.js +1 -1
- package/dist/esm/models/revert-award-request-dto.d.ts +1 -1
- package/dist/esm/models/revert-award-request-dto.js +1 -1
- package/dist/esm/models/revert-award200-response.d.ts +1 -1
- package/dist/esm/models/revert-award200-response.js +1 -1
- package/dist/esm/models/revoke-request-dto.d.ts +1 -1
- package/dist/esm/models/revoke-request-dto.js +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/esm/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/esm/models/send-webhook-test-event200-response.js +1 -1
- package/dist/esm/models/statement-document-dto.d.ts +1 -1
- package/dist/esm/models/statement-document-dto.js +1 -1
- package/dist/esm/models/statement-product-dto.d.ts +1 -1
- package/dist/esm/models/statement-product-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/esm/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/esm/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/esm/models/supplier-tax-type.d.ts +1 -1
- package/dist/esm/models/supplier-tax-type.js +1 -1
- package/dist/esm/models/token-request-dto.d.ts +1 -1
- package/dist/esm/models/token-request-dto.js +1 -1
- package/dist/esm/models/token-response-dto.d.ts +1 -1
- package/dist/esm/models/token-response-dto.js +1 -1
- package/dist/esm/models/update-bid-request-dto.d.ts +1 -1
- package/dist/esm/models/update-bid-request-dto.js +1 -1
- package/dist/esm/models/update-bid200-response.d.ts +1 -1
- package/dist/esm/models/update-bid200-response.js +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/esm/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/esm/models/upload-file-request-dto.d.ts +1 -1
- package/dist/esm/models/upload-file-request-dto.js +1 -1
- package/dist/esm/models/upload-file201-response.d.ts +1 -1
- package/dist/esm/models/upload-file201-response.js +1 -1
- package/dist/esm/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/esm/models/upload-url-created-response-dto.js +1 -1
- package/dist/esm/models/webhook-bid-event-data.d.ts +33 -0
- package/dist/esm/models/webhook-bid-event-data.js +14 -0
- package/dist/esm/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/esm/models/webhook-delivery-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-dto.js +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/esm/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/esm/models/webhook-event-envelope.d.ts +34 -0
- package/dist/esm/models/webhook-event-envelope.js +14 -0
- package/dist/esm/models/webhook-ping-event-data.d.ts +20 -0
- package/dist/esm/models/webhook-ping-event-data.js +14 -0
- package/dist/esm/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/esm/models/webhook-test-result-dto.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/acceptance-result-response-dto.d.ts +1 -1
- package/dist/models/acceptance-result-response-dto.js +1 -1
- package/dist/models/acknowledge-product-receipt200-response.d.ts +1 -1
- package/dist/models/acknowledge-product-receipt200-response.js +1 -1
- package/dist/models/acknowledge-products-request-dto.d.ts +1 -1
- package/dist/models/acknowledge-products-request-dto.js +1 -1
- package/dist/models/api-catalog-dto.d.ts +1 -1
- package/dist/models/api-catalog-dto.js +1 -1
- package/dist/models/api-catalog-entry-dto.d.ts +1 -1
- package/dist/models/api-catalog-entry-dto.js +1 -1
- package/dist/models/api-catalog-link-dto.d.ts +1 -1
- package/dist/models/api-catalog-link-dto.js +1 -1
- package/dist/models/authorization-server-metadata-dto.d.ts +1 -1
- package/dist/models/authorization-server-metadata-dto.js +1 -1
- package/dist/models/award-method-public.d.ts +1 -1
- package/dist/models/award-method-public.js +1 -1
- package/dist/models/award-registered-v2-response-dto.d.ts +1 -1
- package/dist/models/award-registered-v2-response-dto.js +1 -1
- package/dist/models/award-reverted-v2-response-dto.d.ts +1 -1
- package/dist/models/award-reverted-v2-response-dto.js +1 -1
- package/dist/models/bid-acceptance-dto.d.ts +1 -1
- package/dist/models/bid-acceptance-dto.js +1 -1
- package/dist/models/bid-attachment-input-dto.d.ts +1 -1
- package/dist/models/bid-attachment-input-dto.js +1 -1
- package/dist/models/bid-bond-dto.d.ts +1 -1
- package/dist/models/bid-bond-dto.js +1 -1
- package/dist/models/bid-cancelled-response-dto.d.ts +1 -1
- package/dist/models/bid-cancelled-response-dto.js +1 -1
- package/dist/models/bid-contact-dto.d.ts +1 -1
- package/dist/models/bid-contact-dto.js +1 -1
- package/dist/models/bid-contacts-dto.d.ts +1 -1
- package/dist/models/bid-contacts-dto.js +1 -1
- package/dist/models/bid-contract-document-dto.d.ts +1 -1
- package/dist/models/bid-contract-document-dto.js +1 -1
- package/dist/models/bid-delivery-terms-dto.d.ts +1 -1
- package/dist/models/bid-delivery-terms-dto.js +1 -1
- package/dist/models/bid-detail-response-dto.d.ts +1 -1
- package/dist/models/bid-detail-response-dto.js +1 -1
- package/dist/models/bid-document-dto.d.ts +1 -1
- package/dist/models/bid-document-dto.js +1 -1
- package/dist/models/bid-failed-v2-response-dto.d.ts +1 -1
- package/dist/models/bid-failed-v2-response-dto.js +1 -1
- package/dist/models/bid-item-dto.d.ts +1 -1
- package/dist/models/bid-item-dto.js +1 -1
- package/dist/models/bid-lifecycle-dto.d.ts +1 -1
- package/dist/models/bid-lifecycle-dto.js +1 -1
- package/dist/models/bid-manager-dto.d.ts +1 -1
- package/dist/models/bid-manager-dto.js +1 -1
- package/dist/models/bid-payment-terms-dto.d.ts +1 -1
- package/dist/models/bid-payment-terms-dto.js +1 -1
- package/dist/models/bid-product-dto.d.ts +1 -1
- package/dist/models/bid-product-dto.js +1 -1
- package/dist/models/bid-public-status.d.ts +1 -1
- package/dist/models/bid-public-status.js +1 -1
- package/dist/models/bid-registered-response-dto.d.ts +1 -1
- package/dist/models/bid-registered-response-dto.js +1 -1
- package/dist/models/bid-result-participant-attachment-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-attachment-dto.js +1 -1
- package/dist/models/bid-result-participant-dto.d.ts +1 -1
- package/dist/models/bid-result-participant-dto.js +1 -1
- package/dist/models/bid-results-response-dto.d.ts +1 -1
- package/dist/models/bid-results-response-dto.js +1 -1
- package/dist/models/bid-settlement-line-item-dto.d.ts +1 -1
- package/dist/models/bid-settlement-line-item-dto.js +1 -1
- package/dist/models/bid-settlement-participant-dto.d.ts +1 -1
- package/dist/models/bid-settlement-participant-dto.js +1 -1
- package/dist/models/bid-settlement-response-dto.d.ts +1 -1
- package/dist/models/bid-settlement-response-dto.js +1 -1
- package/dist/models/bid-statement-response-dto.d.ts +1 -1
- package/dist/models/bid-statement-response-dto.js +1 -1
- package/dist/models/bid-summary-dto.d.ts +1 -1
- package/dist/models/bid-summary-dto.js +1 -1
- package/dist/models/bid-type-public.d.ts +1 -1
- package/dist/models/bid-type-public.js +1 -1
- package/dist/models/bid-updated-response-dto.d.ts +1 -1
- package/dist/models/bid-updated-response-dto.js +1 -1
- package/dist/models/cancel-bid-request-dto.d.ts +1 -1
- package/dist/models/cancel-bid-request-dto.js +1 -1
- package/dist/models/cancel-bid200-response.d.ts +1 -1
- package/dist/models/cancel-bid200-response.js +1 -1
- package/dist/models/card-payment-request-response-dto.d.ts +1 -1
- package/dist/models/card-payment-request-response-dto.js +1 -1
- package/dist/models/complete-acceptance-request-dto.d.ts +1 -1
- package/dist/models/complete-acceptance-request-dto.js +1 -1
- package/dist/models/complete-acceptance200-response.d.ts +1 -1
- package/dist/models/complete-acceptance200-response.js +1 -1
- package/dist/models/complete-invoice200-response.d.ts +1 -1
- package/dist/models/complete-invoice200-response.js +1 -1
- package/dist/models/complete-upload-request-dto.d.ts +1 -1
- package/dist/models/complete-upload-request-dto.js +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.d.ts +1 -1
- package/dist/models/contract-restriction-confirm-input-dto.js +1 -1
- package/dist/models/create-bid-request-dto.d.ts +1 -1
- package/dist/models/create-bid-request-dto.js +1 -1
- package/dist/models/create-card-payment-dto.d.ts +1 -1
- package/dist/models/create-card-payment-dto.js +1 -1
- package/dist/models/create-card-payment-request-dto.d.ts +1 -1
- package/dist/models/create-card-payment-request-dto.js +1 -1
- package/dist/models/create-card-payment200-response.d.ts +1 -1
- package/dist/models/create-card-payment200-response.js +1 -1
- package/dist/models/create-embed-launch201-response.d.ts +1 -1
- package/dist/models/create-embed-launch201-response.js +1 -1
- package/dist/models/create-external-contract-documents-request-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-request-dto.js +1 -1
- package/dist/models/create-external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/create-external-contract-documents-response-dto.js +1 -1
- package/dist/models/create-file-upload-url201-response.d.ts +1 -1
- package/dist/models/create-file-upload-url201-response.js +1 -1
- package/dist/models/create-upload-url-request-dto.d.ts +1 -1
- package/dist/models/create-upload-url-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/create-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/create-webhook-endpoint201-response.d.ts +1 -1
- package/dist/models/create-webhook-endpoint201-response.js +1 -1
- package/dist/models/delivery-date-type-public.d.ts +1 -1
- package/dist/models/delivery-date-type-public.js +1 -1
- package/dist/models/delivery-method-public.d.ts +1 -1
- package/dist/models/delivery-method-public.js +1 -1
- package/dist/models/embed-launch-request-dto.d.ts +1 -1
- package/dist/models/embed-launch-request-dto.js +1 -1
- package/dist/models/embed-launch-response-dto.d.ts +1 -1
- package/dist/models/embed-launch-response-dto.js +1 -1
- package/dist/models/excellent-procurement-public.d.ts +1 -1
- package/dist/models/excellent-procurement-public.js +1 -1
- package/dist/models/external-contract-document-item-dto.d.ts +1 -1
- package/dist/models/external-contract-document-item-dto.js +1 -1
- package/dist/models/external-contract-documents-response-dto.d.ts +1 -1
- package/dist/models/external-contract-documents-response-dto.js +1 -1
- package/dist/models/external-contract-item-dto.d.ts +1 -1
- package/dist/models/external-contract-item-dto.js +1 -1
- package/dist/models/external-contract-snapshot-dto.d.ts +1 -1
- package/dist/models/external-contract-snapshot-dto.js +1 -1
- package/dist/models/external-document-inputs-dto.d.ts +1 -1
- package/dist/models/external-document-inputs-dto.js +1 -1
- package/dist/models/file-meta-response-dto.d.ts +1 -1
- package/dist/models/file-meta-response-dto.js +1 -1
- package/dist/models/file-uploaded-response-dto.d.ts +1 -1
- package/dist/models/file-uploaded-response-dto.js +1 -1
- package/dist/models/generated-external-contract-document-dto.d.ts +1 -1
- package/dist/models/generated-external-contract-document-dto.js +1 -1
- package/dist/models/get-bid-settlement200-response.d.ts +1 -1
- package/dist/models/get-bid-settlement200-response.js +1 -1
- package/dist/models/get-bid-statement200-response.d.ts +1 -1
- package/dist/models/get-bid-statement200-response.js +1 -1
- package/dist/models/get-bid200-response.d.ts +1 -1
- package/dist/models/get-bid200-response.js +1 -1
- package/dist/models/get-file-meta200-response.d.ts +1 -1
- package/dist/models/get-file-meta200-response.js +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.d.ts +1 -1
- package/dist/models/get-supplier-card-payable-v2200-response.js +1 -1
- package/dist/models/get-webhook-endpoint200-response.d.ts +1 -1
- package/dist/models/get-webhook-endpoint200-response.js +1 -1
- package/dist/models/green-product-public.d.ts +1 -1
- package/dist/models/green-product-public.js +1 -1
- package/dist/models/health-controller-check200-response.d.ts +1 -1
- package/dist/models/health-controller-check200-response.js +1 -1
- package/dist/models/health-response-dto.d.ts +1 -1
- package/dist/models/health-response-dto.js +1 -1
- package/dist/models/hierarchical-region-dto.d.ts +1 -1
- package/dist/models/hierarchical-region-dto.js +1 -1
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/dist/models/introspect-request-dto.d.ts +1 -1
- package/dist/models/introspect-request-dto.js +1 -1
- package/dist/models/introspection-response-dto.d.ts +1 -1
- package/dist/models/introspection-response-dto.js +1 -1
- package/dist/models/invalid-param-dto.d.ts +1 -1
- package/dist/models/invalid-param-dto.js +1 -1
- package/dist/models/invoice-completed-response-dto.d.ts +1 -1
- package/dist/models/invoice-completed-response-dto.js +1 -1
- package/dist/models/invoice-split-response-dto.d.ts +1 -1
- package/dist/models/invoice-split-response-dto.js +1 -1
- package/dist/models/legal-mandatory-public.d.ts +1 -1
- package/dist/models/legal-mandatory-public.js +1 -1
- package/dist/models/list-bid-results200-response.d.ts +1 -1
- package/dist/models/list-bid-results200-response.js +1 -1
- package/dist/models/list-bids200-response-meta.d.ts +1 -1
- package/dist/models/list-bids200-response-meta.js +1 -1
- package/dist/models/list-bids200-response.d.ts +1 -1
- package/dist/models/list-bids200-response.js +1 -1
- package/dist/models/list-products200-response.d.ts +1 -1
- package/dist/models/list-products200-response.js +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.d.ts +1 -1
- package/dist/models/list-webhook-deliveries-response-dto.js +1 -1
- package/dist/models/list-webhook-deliveries200-response.d.ts +1 -1
- package/dist/models/list-webhook-deliveries200-response.js +1 -1
- package/dist/models/list-webhook-endpoints200-response.d.ts +1 -1
- package/dist/models/list-webhook-endpoints200-response.js +1 -1
- package/dist/models/mark-bid-failed-request-dto.d.ts +1 -1
- package/dist/models/mark-bid-failed-request-dto.js +1 -1
- package/dist/models/mark-bid-failed201-response.d.ts +1 -1
- package/dist/models/mark-bid-failed201-response.js +1 -1
- package/dist/models/negotiation-score-dto.d.ts +1 -1
- package/dist/models/negotiation-score-dto.js +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.d.ts +1 -1
- package/dist/models/negotiation-scored-v2-response-dto.js +1 -1
- package/dist/models/oauth-error-response-dto.d.ts +1 -1
- package/dist/models/oauth-error-response-dto.js +1 -1
- package/dist/models/on-bid-award-reverted-request.d.ts +16 -0
- package/dist/models/on-bid-award-reverted-request.js +15 -0
- package/dist/models/on-bid-awarded-request.d.ts +16 -0
- package/dist/models/on-bid-awarded-request.js +15 -0
- package/dist/models/on-bid-canceled-request.d.ts +16 -0
- package/dist/models/on-bid-canceled-request.js +15 -0
- package/dist/models/on-bid-closed-request.d.ts +16 -0
- package/dist/models/on-bid-closed-request.js +15 -0
- package/dist/models/on-bid-failed-request.d.ts +16 -0
- package/dist/models/on-bid-failed-request.js +15 -0
- package/dist/models/on-ping-request.d.ts +16 -0
- package/dist/models/on-ping-request.js +15 -0
- package/dist/models/partner-webhook-delivery-status.d.ts +1 -1
- package/dist/models/partner-webhook-delivery-status.js +1 -1
- package/dist/models/partner-webhook-endpoint-status.d.ts +1 -1
- package/dist/models/partner-webhook-endpoint-status.js +1 -1
- package/dist/models/partner-webhook-event-type.d.ts +1 -1
- package/dist/models/partner-webhook-event-type.js +1 -1
- package/dist/models/payment-method-public.d.ts +1 -1
- package/dist/models/payment-method-public.js +1 -1
- package/dist/models/preconditions-dto.d.ts +1 -1
- package/dist/models/preconditions-dto.js +1 -1
- package/dist/models/problem-details-dto.d.ts +1 -1
- package/dist/models/problem-details-dto.js +1 -1
- package/dist/models/product-receipt-response-dto.d.ts +1 -1
- package/dist/models/product-receipt-response-dto.js +1 -1
- package/dist/models/product-response-dto.d.ts +1 -1
- package/dist/models/product-response-dto.js +1 -1
- package/dist/models/protected-resource-metadata-dto.d.ts +1 -1
- package/dist/models/protected-resource-metadata-dto.js +1 -1
- package/dist/models/register-award-request-dto.d.ts +1 -1
- package/dist/models/register-award-request-dto.js +1 -1
- package/dist/models/register-award201-response.d.ts +1 -1
- package/dist/models/register-award201-response.js +1 -1
- package/dist/models/register-bid201-response.d.ts +1 -1
- package/dist/models/register-bid201-response.js +1 -1
- package/dist/models/register-semo-contract-request-dto.d.ts +1 -1
- package/dist/models/register-semo-contract-request-dto.js +1 -1
- package/dist/models/request-invoice-split-request-dto.d.ts +1 -1
- package/dist/models/request-invoice-split-request-dto.js +1 -1
- package/dist/models/request-invoice-split200-response.d.ts +1 -1
- package/dist/models/request-invoice-split200-response.js +1 -1
- package/dist/models/retiree-roster-input-dto.d.ts +1 -1
- package/dist/models/retiree-roster-input-dto.js +1 -1
- package/dist/models/retiree-roster-row-dto.d.ts +1 -1
- package/dist/models/retiree-roster-row-dto.js +1 -1
- package/dist/models/revert-award-request-dto.d.ts +1 -1
- package/dist/models/revert-award-request-dto.js +1 -1
- package/dist/models/revert-award200-response.d.ts +1 -1
- package/dist/models/revert-award200-response.js +1 -1
- package/dist/models/revoke-request-dto.d.ts +1 -1
- package/dist/models/revoke-request-dto.js +1 -1
- package/dist/models/semo-contract-registered-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-registered-response-dto.js +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.d.ts +1 -1
- package/dist/models/semo-contract-taxinvoice-status-response-dto.js +1 -1
- package/dist/models/send-webhook-test-event200-response.d.ts +1 -1
- package/dist/models/send-webhook-test-event200-response.js +1 -1
- package/dist/models/statement-document-dto.d.ts +1 -1
- package/dist/models/statement-document-dto.js +1 -1
- package/dist/models/statement-product-dto.d.ts +1 -1
- package/dist/models/statement-product-dto.js +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.d.ts +1 -1
- package/dist/models/submit-negotiation-scores-request-dto.js +1 -1
- package/dist/models/submit-negotiation-scores201-response.d.ts +1 -1
- package/dist/models/submit-negotiation-scores201-response.js +1 -1
- package/dist/models/supplier-card-payable-response-dto.d.ts +1 -1
- package/dist/models/supplier-card-payable-response-dto.js +1 -1
- package/dist/models/supplier-tax-type.d.ts +1 -1
- package/dist/models/supplier-tax-type.js +1 -1
- package/dist/models/token-request-dto.d.ts +1 -1
- package/dist/models/token-request-dto.js +1 -1
- package/dist/models/token-response-dto.d.ts +1 -1
- package/dist/models/token-response-dto.js +1 -1
- package/dist/models/update-bid-request-dto.d.ts +1 -1
- package/dist/models/update-bid-request-dto.js +1 -1
- package/dist/models/update-bid200-response.d.ts +1 -1
- package/dist/models/update-bid200-response.js +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.d.ts +1 -1
- package/dist/models/update-webhook-endpoint-request-dto.js +1 -1
- package/dist/models/upload-file-request-dto.d.ts +1 -1
- package/dist/models/upload-file-request-dto.js +1 -1
- package/dist/models/upload-file201-response.d.ts +1 -1
- package/dist/models/upload-file201-response.js +1 -1
- package/dist/models/upload-url-created-response-dto.d.ts +1 -1
- package/dist/models/upload-url-created-response-dto.js +1 -1
- package/dist/models/webhook-bid-event-data.d.ts +33 -0
- package/dist/models/webhook-bid-event-data.js +15 -0
- package/dist/models/webhook-delivery-dto.d.ts +1 -1
- package/dist/models/webhook-delivery-dto.js +1 -1
- package/dist/models/webhook-endpoint-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-dto.js +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.d.ts +1 -1
- package/dist/models/webhook-endpoint-with-secret-dto.js +1 -1
- package/dist/models/webhook-event-envelope.d.ts +34 -0
- package/dist/models/webhook-event-envelope.js +15 -0
- package/dist/models/webhook-ping-event-data.d.ts +20 -0
- package/dist/models/webhook-ping-event-data.js +15 -0
- package/dist/models/webhook-test-result-dto.d.ts +1 -1
- package/dist/models/webhook-test-result-dto.js +1 -1
- package/docs/OnBidAwardRevertedRequest.md +26 -0
- package/docs/OnBidAwardedRequest.md +26 -0
- package/docs/OnBidCanceledRequest.md +26 -0
- package/docs/OnBidClosedRequest.md +26 -0
- package/docs/OnBidFailedRequest.md +26 -0
- package/docs/OnPingRequest.md +26 -0
- package/docs/PartnerApiApi.md +65 -13
- package/docs/ProductsApi.md +5 -1
- package/docs/WebhookBidEventData.md +27 -0
- package/docs/WebhookEventEnvelope.md +27 -0
- package/docs/WebhookPingEventData.md +21 -0
- package/docs/WebhooksApi.md +403 -0
- package/index.ts +1 -1
- package/models/acceptance-result-response-dto.ts +1 -1
- package/models/acknowledge-product-receipt200-response.ts +1 -1
- package/models/acknowledge-products-request-dto.ts +1 -1
- package/models/api-catalog-dto.ts +1 -1
- package/models/api-catalog-entry-dto.ts +1 -1
- package/models/api-catalog-link-dto.ts +1 -1
- package/models/authorization-server-metadata-dto.ts +1 -1
- package/models/award-method-public.ts +1 -1
- package/models/award-registered-v2-response-dto.ts +1 -1
- package/models/award-reverted-v2-response-dto.ts +1 -1
- package/models/bid-acceptance-dto.ts +1 -1
- package/models/bid-attachment-input-dto.ts +1 -1
- package/models/bid-bond-dto.ts +1 -1
- package/models/bid-cancelled-response-dto.ts +1 -1
- package/models/bid-contact-dto.ts +1 -1
- package/models/bid-contacts-dto.ts +1 -1
- package/models/bid-contract-document-dto.ts +1 -1
- package/models/bid-delivery-terms-dto.ts +1 -1
- package/models/bid-detail-response-dto.ts +1 -1
- package/models/bid-document-dto.ts +1 -1
- package/models/bid-failed-v2-response-dto.ts +1 -1
- package/models/bid-item-dto.ts +1 -1
- package/models/bid-lifecycle-dto.ts +1 -1
- package/models/bid-manager-dto.ts +1 -1
- package/models/bid-payment-terms-dto.ts +1 -1
- package/models/bid-product-dto.ts +1 -1
- package/models/bid-public-status.ts +1 -1
- package/models/bid-registered-response-dto.ts +1 -1
- package/models/bid-result-participant-attachment-dto.ts +1 -1
- package/models/bid-result-participant-dto.ts +1 -1
- package/models/bid-results-response-dto.ts +1 -1
- package/models/bid-settlement-line-item-dto.ts +1 -1
- package/models/bid-settlement-participant-dto.ts +1 -1
- package/models/bid-settlement-response-dto.ts +1 -1
- package/models/bid-statement-response-dto.ts +1 -1
- package/models/bid-summary-dto.ts +1 -1
- package/models/bid-type-public.ts +1 -1
- package/models/bid-updated-response-dto.ts +1 -1
- package/models/cancel-bid-request-dto.ts +1 -1
- package/models/cancel-bid200-response.ts +1 -1
- package/models/card-payment-request-response-dto.ts +1 -1
- package/models/complete-acceptance-request-dto.ts +1 -1
- package/models/complete-acceptance200-response.ts +1 -1
- package/models/complete-invoice200-response.ts +1 -1
- package/models/complete-upload-request-dto.ts +1 -1
- package/models/contract-restriction-confirm-input-dto.ts +1 -1
- package/models/create-bid-request-dto.ts +1 -1
- package/models/create-card-payment-dto.ts +1 -1
- package/models/create-card-payment-request-dto.ts +1 -1
- package/models/create-card-payment200-response.ts +1 -1
- package/models/create-embed-launch201-response.ts +1 -1
- package/models/create-external-contract-documents-request-dto.ts +1 -1
- package/models/create-external-contract-documents-response-dto.ts +1 -1
- package/models/create-file-upload-url201-response.ts +1 -1
- package/models/create-upload-url-request-dto.ts +1 -1
- package/models/create-webhook-endpoint-request-dto.ts +1 -1
- package/models/create-webhook-endpoint201-response.ts +1 -1
- package/models/delivery-date-type-public.ts +1 -1
- package/models/delivery-method-public.ts +1 -1
- package/models/embed-launch-request-dto.ts +1 -1
- package/models/embed-launch-response-dto.ts +1 -1
- package/models/excellent-procurement-public.ts +1 -1
- package/models/external-contract-document-item-dto.ts +1 -1
- package/models/external-contract-documents-response-dto.ts +1 -1
- package/models/external-contract-item-dto.ts +1 -1
- package/models/external-contract-snapshot-dto.ts +1 -1
- package/models/external-document-inputs-dto.ts +1 -1
- package/models/file-meta-response-dto.ts +1 -1
- package/models/file-uploaded-response-dto.ts +1 -1
- package/models/generated-external-contract-document-dto.ts +1 -1
- package/models/get-bid-settlement200-response.ts +1 -1
- package/models/get-bid-statement200-response.ts +1 -1
- package/models/get-bid200-response.ts +1 -1
- package/models/get-file-meta200-response.ts +1 -1
- package/models/get-supplier-card-payable-v2200-response.ts +1 -1
- package/models/get-webhook-endpoint200-response.ts +1 -1
- package/models/green-product-public.ts +1 -1
- package/models/health-controller-check200-response.ts +1 -1
- package/models/health-response-dto.ts +1 -1
- package/models/hierarchical-region-dto.ts +1 -1
- package/models/index.ts +9 -0
- package/models/introspect-request-dto.ts +1 -1
- package/models/introspection-response-dto.ts +1 -1
- package/models/invalid-param-dto.ts +1 -1
- package/models/invoice-completed-response-dto.ts +1 -1
- package/models/invoice-split-response-dto.ts +1 -1
- package/models/legal-mandatory-public.ts +1 -1
- package/models/list-bid-results200-response.ts +1 -1
- package/models/list-bids200-response-meta.ts +1 -1
- package/models/list-bids200-response.ts +1 -1
- package/models/list-products200-response.ts +1 -1
- package/models/list-webhook-deliveries-response-dto.ts +1 -1
- package/models/list-webhook-deliveries200-response.ts +1 -1
- package/models/list-webhook-endpoints200-response.ts +1 -1
- package/models/mark-bid-failed-request-dto.ts +1 -1
- package/models/mark-bid-failed201-response.ts +1 -1
- package/models/negotiation-score-dto.ts +1 -1
- package/models/negotiation-scored-v2-response-dto.ts +1 -1
- package/models/oauth-error-response-dto.ts +1 -1
- package/models/on-bid-award-reverted-request.ts +28 -0
- package/models/on-bid-awarded-request.ts +28 -0
- package/models/on-bid-canceled-request.ts +28 -0
- package/models/on-bid-closed-request.ts +28 -0
- package/models/on-bid-failed-request.ts +28 -0
- package/models/on-ping-request.ts +28 -0
- package/models/partner-webhook-delivery-status.ts +1 -1
- package/models/partner-webhook-endpoint-status.ts +1 -1
- package/models/partner-webhook-event-type.ts +1 -1
- package/models/payment-method-public.ts +1 -1
- package/models/preconditions-dto.ts +1 -1
- package/models/problem-details-dto.ts +1 -1
- package/models/product-receipt-response-dto.ts +1 -1
- package/models/product-response-dto.ts +1 -1
- package/models/protected-resource-metadata-dto.ts +1 -1
- package/models/register-award-request-dto.ts +1 -1
- package/models/register-award201-response.ts +1 -1
- package/models/register-bid201-response.ts +1 -1
- package/models/register-semo-contract-request-dto.ts +1 -1
- package/models/request-invoice-split-request-dto.ts +1 -1
- package/models/request-invoice-split200-response.ts +1 -1
- package/models/retiree-roster-input-dto.ts +1 -1
- package/models/retiree-roster-row-dto.ts +1 -1
- package/models/revert-award-request-dto.ts +1 -1
- package/models/revert-award200-response.ts +1 -1
- package/models/revoke-request-dto.ts +1 -1
- package/models/semo-contract-registered-response-dto.ts +1 -1
- package/models/semo-contract-taxinvoice-status-response-dto.ts +1 -1
- package/models/send-webhook-test-event200-response.ts +1 -1
- package/models/statement-document-dto.ts +1 -1
- package/models/statement-product-dto.ts +1 -1
- package/models/submit-negotiation-scores-request-dto.ts +1 -1
- package/models/submit-negotiation-scores201-response.ts +1 -1
- package/models/supplier-card-payable-response-dto.ts +1 -1
- package/models/supplier-tax-type.ts +1 -1
- package/models/token-request-dto.ts +1 -1
- package/models/token-response-dto.ts +1 -1
- package/models/update-bid-request-dto.ts +1 -1
- package/models/update-bid200-response.ts +1 -1
- package/models/update-webhook-endpoint-request-dto.ts +1 -1
- package/models/upload-file-request-dto.ts +1 -1
- package/models/upload-file201-response.ts +1 -1
- package/models/upload-url-created-response-dto.ts +1 -1
- package/models/webhook-bid-event-data.ts +43 -0
- package/models/webhook-delivery-dto.ts +1 -1
- package/models/webhook-endpoint-dto.ts +1 -1
- package/models/webhook-endpoint-with-secret-dto.ts +1 -1
- package/models/webhook-event-envelope.ts +38 -0
- package/models/webhook-ping-event-data.ts +26 -0
- package/models/webhook-test-result-dto.ts +1 -1
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* CMARKET V6 Partner API
|
|
3
3
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token` μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403` μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403 μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£Όμ² λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2` μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }` μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data` κ° λ°°μ΄μ΄κ³ `meta` κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta` κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*` μ `/.well-known/_*` λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728 μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSON μ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+json μ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2` μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified` λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json` μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId` μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId` λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type` μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1 μ΄ νμ©νλ λλ‘ μ΄ URI λ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409 μ 422 μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ body λ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id` κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slug μ **HTTP status λ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 38.
|
|
5
|
+
* The version of the OpenAPI document: 38.3.0
|
|
6
6
|
* Contact: semo.io.kr@gmail.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -32,10 +32,11 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32
32
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
33
33
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
34
34
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
35
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
35
36
|
* @param {*} [options] Override http request option.
|
|
36
37
|
* @throws {RequiredError}
|
|
37
38
|
*/
|
|
38
|
-
listProducts: (limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
|
+
listProducts: (limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
40
|
};
|
|
40
41
|
/**
|
|
41
42
|
* ProductsApi - functional programming interface
|
|
@@ -54,10 +55,11 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
54
55
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
55
56
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
56
57
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
58
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
57
59
|
* @param {*} [options] Override http request option.
|
|
58
60
|
* @throws {RequiredError}
|
|
59
61
|
*/
|
|
60
|
-
listProducts(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProducts200Response>>;
|
|
62
|
+
listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProducts200Response>>;
|
|
61
63
|
};
|
|
62
64
|
/**
|
|
63
65
|
* ProductsApi - factory interface
|
|
@@ -76,10 +78,11 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
76
78
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
77
79
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
78
80
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
81
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
79
82
|
* @param {*} [options] Override http request option.
|
|
80
83
|
* @throws {RequiredError}
|
|
81
84
|
*/
|
|
82
|
-
listProducts(limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListProducts200Response>;
|
|
85
|
+
listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListProducts200Response>;
|
|
83
86
|
};
|
|
84
87
|
/**
|
|
85
88
|
* ProductsApi - object-oriented interface
|
|
@@ -98,8 +101,9 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
98
101
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
99
102
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
100
103
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
104
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
101
105
|
* @param {*} [options] Override http request option.
|
|
102
106
|
* @throws {RequiredError}
|
|
103
107
|
*/
|
|
104
|
-
listProducts(limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProducts200Response, any, {}>>;
|
|
108
|
+
listProducts(limit?: number, ifNoneMatch?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProducts200Response, any, {}>>;
|
|
105
109
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* CMARKET V6 Partner API
|
|
5
5
|
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token` μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403` μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403 μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£Όμ² λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2` μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }` μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data` κ° λ°°μ΄μ΄κ³ `meta` κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta` κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*` μ `/.well-known/_*` λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728 μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSON μ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+json μ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2` μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified` λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json` μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId` μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId` λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type` μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1 μ΄ νμ©νλ λλ‘ μ΄ URI λ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409 μ 422 μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ body λ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id` κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slug μ **HTTP status λ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 38.
|
|
7
|
+
* The version of the OpenAPI document: 38.3.0
|
|
8
8
|
* Contact: semo.io.kr@gmail.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -75,10 +75,11 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
75
75
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
76
76
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
77
77
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
78
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
78
79
|
* @param {*} [options] Override http request option.
|
|
79
80
|
* @throws {RequiredError}
|
|
80
81
|
*/
|
|
81
|
-
listProducts: (limit_1, ...args_1) => __awaiter(this, [limit_1, ...args_1], void 0, function* (limit, options = {}) {
|
|
82
|
+
listProducts: (limit_1, ifNoneMatch_1, ...args_1) => __awaiter(this, [limit_1, ifNoneMatch_1, ...args_1], void 0, function* (limit, ifNoneMatch, options = {}) {
|
|
82
83
|
const localVarPath = `/v2/products`;
|
|
83
84
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84
85
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -96,6 +97,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
96
97
|
localVarQueryParameter['limit'] = limit;
|
|
97
98
|
}
|
|
98
99
|
localVarHeaderParameter['Accept'] = 'application/json,application/problem+json';
|
|
100
|
+
if (ifNoneMatch != null) {
|
|
101
|
+
localVarHeaderParameter['If-None-Match'] = String(ifNoneMatch);
|
|
102
|
+
}
|
|
99
103
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
100
104
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
101
105
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -133,13 +137,14 @@ export const ProductsApiFp = function (configuration) {
|
|
|
133
137
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
134
138
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
135
139
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
140
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
136
141
|
* @param {*} [options] Override http request option.
|
|
137
142
|
* @throws {RequiredError}
|
|
138
143
|
*/
|
|
139
|
-
listProducts(limit, options) {
|
|
144
|
+
listProducts(limit, ifNoneMatch, options) {
|
|
140
145
|
return __awaiter(this, void 0, void 0, function* () {
|
|
141
146
|
var _a, _b, _c;
|
|
142
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(limit, options);
|
|
147
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(limit, ifNoneMatch, options);
|
|
143
148
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
144
149
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
145
150
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -168,11 +173,12 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
168
173
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
169
174
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
170
175
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
176
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
171
177
|
* @param {*} [options] Override http request option.
|
|
172
178
|
* @throws {RequiredError}
|
|
173
179
|
*/
|
|
174
|
-
listProducts(limit, options) {
|
|
175
|
-
return localVarFp.listProducts(limit, options).then((request) => request(axios, basePath));
|
|
180
|
+
listProducts(limit, ifNoneMatch, options) {
|
|
181
|
+
return localVarFp.listProducts(limit, ifNoneMatch, options).then((request) => request(axios, basePath));
|
|
176
182
|
},
|
|
177
183
|
};
|
|
178
184
|
};
|
|
@@ -195,10 +201,11 @@ export class ProductsApi extends BaseAPI {
|
|
|
195
201
|
* κΈ°κ΄μ 곡μ λ λ¬Όν μ€ **μμ§ μ μ‘λμ§ μμ κ²**μ μ‘°νν©λλ€. **μ¦λΆ νΌλμ
λλ€.** κ°μ Έκ° λ¬Όνμ `POST /v2/products/receipts` λ‘ μμ νμΈνλ©΄ λ€μ μ‘°ν κ²°κ³Όμμ λΉ μ§λλ€. μμ νμΈμ νμ§ μμΌλ©΄ κ°μ λ¬Όνμ΄ κ³μ λ΄λ €μ΅λλ€. **κΆμ₯ νλ¦:** μ‘°ν β μκΈ° μμ€ν
μ μ μ₯ β μ μ₯μ μ±κ³΅ν λ¬Όν μ½λλ§ μμ νμΈ. μ μ₯ μ μ μμ νμΈνλ©΄ κ·Έ λ¬Όνμ λ€μ λ°μ μ μμ΅λλ€. **λλ λ°κΈ°:** `limit` μ μ£Όλ©΄ κ·Έλ§νΌλ§ λ°κ³ , λ¨μ κ²μ΄ μμΌλ©΄ `meta.hasMore` κ° `true` μ
λλ€. 컀μλ μμ΅λλ€ β λ€μ λ¬Άμμ \"컀μ λ€μ\" μ΄ μλλΌ **μμ§ μμ νμΈνμ§ μμ κ²**μ΄λΌ, μ νλ¦μ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νλ©΄ λ©λλ€. `limit` μ λΉΌλ©΄ μ λΆ ν λ²μ λ°μ΅λλ€. **μ‘°ν λ²μ:** μμ² ν€κ° λννλ κΈ°κ΄ κ·Έλ£Ήμ
λλ€. κΈ°κ΄ κ·Έλ£Ήμ΄ μ€μ λμ§ μμ ν€λ 403 μ
λλ€. **νμ μ€μ½ν:** `products:read`
|
|
196
202
|
* @summary λ¬Όν μΉ΄νλ‘κ·Έ μ‘°ν
|
|
197
203
|
* @param {number} [limit] ν λ²μ λ°μ μ΅λ λ¬Όν μ(1~1000). λ―Έμ§μ μ΄λ©΄ λ―Έμ μ‘ λ¬Όνμ **μ λΆ** λ°μ΅λλ€(μ’
μ λμ). μΉ΄νλ‘κ·Έκ° μ»€μ μλ΅μ΄ λΆλ΄μ€λ¬μ°λ©΄ μ΄ κ°μ μ£Όκ³ `meta.hasMore` κ° `false` κ° λ λκΉμ§ λ°λ³΅νμΈμ.
|
|
204
|
+
* @param {string} [ifNoneMatch] μ§μ μλ΅μ `ETag` κ°. λ΄μ©μ΄ κ·Έλλ‘λ©΄ λ³Έλ¬Έ μμ΄ `304` λ‘ λλ©λλ€ β ν΄λ§μμ μ μ‘λκ³Ό νμ± λΉμ©μ΄ μ¬λΌμ§λλ€.
|
|
198
205
|
* @param {*} [options] Override http request option.
|
|
199
206
|
* @throws {RequiredError}
|
|
200
207
|
*/
|
|
201
|
-
listProducts(limit, options) {
|
|
202
|
-
return ProductsApiFp(this.configuration).listProducts(limit, options).then((request) => request(this.axios, this.basePath));
|
|
208
|
+
listProducts(limit, ifNoneMatch, options) {
|
|
209
|
+
return ProductsApiFp(this.configuration).listProducts(limit, ifNoneMatch, options).then((request) => request(this.axios, this.basePath));
|
|
203
210
|
}
|
|
204
211
|
}
|
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CMARKET V6 Partner API
|
|
3
|
+
* μΈλΆ ERP μ°λμ© RESTful API. ## μΈμ¦ OAuth2 Bearer JWT (`client_credentials` νλ‘μ°). `/oauth/token` μμ ν ν°μ λ°κΈλ°μ `Authorization: Bearer <token>` ν€λλ‘ μ€μΌμΈμ. ## κΆν β λ κ°μ λ
립λ μΆ `403` μ λ§λ¬λ€λ©΄ λ μ€ μ΄λ μΆμ κ±Έλ¦° κ²μΈμ§ λ¨Όμ ꡬλΆνμΈμ. - **μ€μ½ν** = *무μμ ν μ μλ*. ν ν°μ λΆμ¬λ `bids:read`Β·`contracts:write` λ±μ
λλ€. 미보μ μ `β¦/insufficient-scope`. - **λν λ²μ** = *λꡬμ λ°μ΄ν°λ₯Ό λ€λ£° μ μλ*. API ν€ μ€μ μ΄λ©° μ€μ½νλ‘ ννλμ§ μμ΅λλ€. λ²μ λ°μ΄λ©΄ μ€μ½νμ 무κ΄νκ² 403 μ
λλ€. λν λ²μλ ν€λ§λ€ λ μ€ νλλ‘ μ€μ λ©λλ€ β **μμ κ·Έλ£Ή μ μ**(κΈ°κ΄ ν€. μ¬μ
μ²Β·λΆμ κ³μ μ΄ μλ‘ μ겨λ μλ ν¬ν¨) λλ **μ§μ λ°μ£Όμ² λͺ©λ‘**(κ³μ½μΌλ‘ ν©μλ λͺ©λ‘). λ²μλ₯Ό λνμΌ νλ©΄ μ€μ½νκ° μλλΌ ν€ μ€μ λ³κ²½μ μμ²νμΈμ. ## μ±κ³΅ μλ΅ λ΄ν¬ `/v2` μ λͺ¨λ 2xx λ³Έλ¬Έμ `{ \"data\": β¦ }` μ
λλ€. λ¨μΌ 리μμ€λ λͺ©λ‘μ΄λ κ°μ΅λλ€. **λͺ©λ‘μ `data` κ° λ°°μ΄μ΄κ³ `meta` κ° νμ ν¨κ» μ€λ¦½λλ€** β `{ \"data\": [...], \"meta\": { \"nextCursor\": \"Mg==\", \"hasMore\": true } }`. λ¨μΌ 리μμ€ μλ΅μλ `meta` κ° λκ°μ§ μμ΅λλ€. λ΄ν¬λ₯Ό μ°μ§ μλ νλ©΄μ λμ
λλ€. `/oauth/_*` μ `/.well-known/_*` λ κ°κ° RFC 6749Β·RFC 8414Β·RFC 9728 μ΄ μ΅μμ νλλ₯Ό κ·μ νκ³ , νμΌ λ΄μ© μλ΅μ λ³Έλ¬Έμ΄ JSON μ΄ μλλλ€. μλ¬ μλ΅μλ λ΄ν¬λ₯Ό μμ°μ§ μμ΅λλ€ β μλ problem+json μ΄ λ¨λ
μΌλ‘ μ±
μμ§λλ€. ## μ‘°κ±΄λΆ μμ² (ETag) `/v2` μ λͺ¨λ `GET` μλ΅μ weak `ETag`(`W/\"β¦\"`)κ° μ€λ¦½λλ€. λ°μ κ°μ λ€μ μμ²μ `If-None-Match` ν€λλ‘ λ보λ΄λ©΄, λ΄μ©μ΄ κ·Έλλ‘μΌ λ `304 Not Modified` λ₯Ό λ³Έλ¬Έ μμ΄ λ°μ΅λλ€. κ²°κ³Όκ° λκΈ°λ₯Ό κΈ°λ€λ¦¬λ©° κ°μ μμμ λ°λ³΅ μ‘°ννλ μ°λμ΄λΌλ©΄ μ΄ ν€λ νλλ‘ μ μ‘λμ΄ μ¬λΌμ§λλ€. ## μλ¬ (RFC 9457 problem+json) λͺ¨λ μλ¬ μλ΅μ `application/problem+json` μ
λλ€. **HTTP status + `type` URI** λ‘ λΆκΈ°νμΈμ. - `retryable`(boolean): μλ μ¬μλ μμ μ¬λΆ. `true`(429Β·5xx transient)λ©΄ backoff ν μ¬μλνκ³ , `false`λ©΄ μμ²μ κ³ μ³μΌ ν©λλ€. - `traceId`: μμ² μΆμ id. `X-Correlation-Id` μλ΅ ν€λμ κ°μ κ°μ
λλ€ β λ¬Έμν λ μ΄ κ°μ 첨λΆνμΈμ. - `correlationId`: `traceId` μ κ°μ κ°μ μ μ΄λ¦. κΈ°μ‘΄ μ°λ νΈνμΌλ‘ ν¨κ» μ€λ¦½λλ€. μ μ°λμ `traceId` λ₯Ό μ½μΌμΈμ. - `invalid-params`: κ²μ¦ μ€ν¨(400 `β¦/validation-failed`) μ μλ° νλ κ²½λ‘ λͺ©λ‘(RFC 9457 νμ₯, κ° μμ). `type` μ `https://problems.cmarket.io/partner/<slug>` ννμ **μμ μλ³μ**μ
λλ€. RFC 9457 Β§3.1.1 μ΄ νμ©νλ λλ‘ μ΄ URI λ **μμ°Έμ‘°(dereference)λμ§ μμ΅λλ€** β λΈλΌμ°μ λ‘ μ΄μ§ λ§κ³ λ¬Έμμ΄ λΉκ΅λ‘λ§ μ°μΈμ. slug λͺ©λ‘κ³Ό μλ―Έλ κ° μλν¬μΈνΈμ μλ΅ μ€λͺ
μ status λ³λ‘ μ ν μμ΅λλ€. ### λ©±λ±μ± μλ°: 409 μ 422 μ μ°¨μ΄ - `409` `β¦/idempotency-key-conflict` β κ°μ ν€μ **μ μμ²μ΄ μμ§ μ²λ¦¬ μ€**μ
λλ€. μ μ λ€ κ°μ ν€λ‘ λ€μ λΆλ₯΄λ©΄ κ·Έ κ²°κ³Όλ₯Ό λ°μ΅λλ€. - `422` `β¦/idempotency-key-reused` β κ°μ ν€λ₯Ό **λ€λ₯Έ body** λ‘ λ³΄λμ΅λλ€. μ¬μλν΄λ μμν κ°μ μ€ν¨μ΄λ μ ν€λ₯Ό μ°κ±°λ body λ₯Ό λλ리μΈμ. ## Rate Limit μ μ **60 μμ²/λΆ per `client_id`**, ν ν° λ°κΈ(`/oauth/token`)μ **5 μμ²/λΆ** μ
λλ€. μ΄κ³Ό μ `429`(`type: β¦/too-many-requests`). μΏΌν°λ λ κ°μ§ νκΈ°λ‘ ν¨κ» λκ°λλ€ β μ κ· μ°λμ νμ€ νλλ₯Ό μ°μΈμ. - **νμ€**(`draft-ietf-httpapi-ratelimit-headers`, Structured Fields): `RateLimit-Policy: \"default\";q=60;w=60` (μ μ±
) Β· `RateLimit: \"default\";r=59;t=42` (μλ r, 리μ
κΉμ§ t μ΄) - **λ κ±°μ**(κ΄μ©): `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset`. κΈ°μ‘΄ μ°λ νΈνμ μν΄ μ μ§ν©λλ€. `429` μμλ `Retry-After`(μ΄)κ° μ°μ ν©λλ€. λλ λκΈ°ν(νλͺ© λ¨μ λ°λ³΅ λ±λ‘ λ±)λ `Retry-After` λ§νΌ backoff ν μ¬μλνμΈμ. ## μΆμ μμ²μ `X-Correlation-Id` ν€λλ₯Ό μ€μΌλ©΄ κ·Έλλ‘ echo λκ³ , μμΌλ©΄ μλ²κ° λ°κΈν©λλ€. λͺ¨λ μλ΅(μ±κ³΅/μλ¬)μ `X-Correlation-Id` κ° μ€λ¦½λλ€. ## μ λ°©νΈν β λͺ¨λ₯΄λ νλμ κ°μμ κΉ¨μ§μ§ μκ² λ€μ μ
μ breaking λ³κ²½μΌλ‘ λ³΄μ§ μμΌλ©° minor 릴리μ€μμ μκ³ μμ΄ μΌμ΄λ©λλ€. μ΄ μ μ λ‘ κ΅¬ννμΈμ. - **μ ν νλ μΆκ°**: λͺ¨λ₯΄λ νλλ 무μνμΈμ. μ격 νμ(unknown key κ±°λΆ)λ₯Ό μ°μ§ λ§μΈμ. - **enum κ° μΆκ°**: μνΒ·λμ°°λ°©λ² λ±μ μ κ°μ΄ μκΉλλ€. λͺ¨λ₯΄λ κ°μ λ§λλ©΄ μμΈλ₯Ό λμ§μ§ λ§κ³ μλ¬Έ λ¬Έμμ΄μ 보쑴νμΈμ. - **problem `type` slug μΆκ°**: λͺ¨λ₯΄λ slug μ **HTTP status λ‘ ν΄λ°±**ν΄ λΆκΈ°νμΈμ. ## λ²μ μλͺ
(deprecation/sunset) - **_/v2** breaking λ³κ²½μ CHANGELOG SemVer(major bump)μ `Deprecation`/`Sunset` ν€λλ‘ ν΅μ§ν©λλ€. μ΄ ν€λλ₯Ό λͺ¨λν°λ§νμΈμ.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 38.3.0
|
|
6
|
+
* Contact: semo.io.kr@gmail.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { OnBidAwardRevertedRequest } from '../models';
|
|
16
|
+
import type { OnBidAwardedRequest } from '../models';
|
|
17
|
+
import type { OnBidCanceledRequest } from '../models';
|
|
18
|
+
import type { OnBidClosedRequest } from '../models';
|
|
19
|
+
import type { OnBidFailedRequest } from '../models';
|
|
20
|
+
import type { OnPingRequest } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* WebhooksApi - axios parameter creator
|
|
23
|
+
*/
|
|
24
|
+
export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
27
|
+
* @summary μ΄μμκ° λμ°°μ λλλ Έμ΅λλ€ β μ΄λ―Έ λ°μ `bid.awarded` λ₯Ό 무ν¨λ‘ μ·¨κΈνμΈμ.
|
|
28
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
29
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
30
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
31
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
32
|
+
* @param {OnBidAwardRevertedRequest} onBidAwardRevertedRequest
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
onBidAwardReverted: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardRevertedRequest: OnBidAwardRevertedRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
39
|
+
* @summary λμ°° νμ .
|
|
40
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
41
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
42
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
43
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
44
|
+
* @param {OnBidAwardedRequest} onBidAwardedRequest
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
onBidAwarded: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardedRequest: OnBidAwardedRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
51
|
+
* @summary λ°μ£ΌκΈ°κ΄ λλ μ΄μμμ κ³΅κ³ μ·¨μ.
|
|
52
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
53
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
54
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
55
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
56
|
+
* @param {OnBidCanceledRequest} onBidCanceledRequest
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
onBidCanceled: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidCanceledRequest: OnBidCanceledRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
|
+
/**
|
|
62
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
63
|
+
* @summary κ³΅κ³ λ§κ° β μμ°° μ μκ° λλ¬μ΅λλ€(λμ°°μλ μμ§ μ ν΄μ§μ§ μμμ΅λλ€).
|
|
64
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
65
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
66
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
67
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
68
|
+
* @param {OnBidClosedRequest} onBidClosedRequest
|
|
69
|
+
* @param {*} [options] Override http request option.
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
*/
|
|
72
|
+
onBidClosed: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidClosedRequest: OnBidClosedRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
|
+
/**
|
|
74
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
75
|
+
* @summary μ μ°° νμ .
|
|
76
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
77
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
78
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
79
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
80
|
+
* @param {OnBidFailedRequest} onBidFailedRequest
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
onBidFailed: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidFailedRequest: OnBidFailedRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
|
+
/**
|
|
86
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
87
|
+
* @summary μ°κ²° νμΈ λ°μ‘. **ꡬλ
ν μ μμ΅λλ€** β `POST /v2/webhook-endpoints/{endpointId}/test` κ° μ¦μ 1ν λ³΄λΌ λλ§ μ΅λλ€.
|
|
88
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
89
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
90
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
91
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
92
|
+
* @param {OnPingRequest} onPingRequest
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
onPing: (webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onPingRequest: OnPingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* WebhooksApi - functional programming interface
|
|
100
|
+
*/
|
|
101
|
+
export declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
102
|
+
/**
|
|
103
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
104
|
+
* @summary μ΄μμκ° λμ°°μ λλλ Έμ΅λλ€ β μ΄λ―Έ λ°μ `bid.awarded` λ₯Ό 무ν¨λ‘ μ·¨κΈνμΈμ.
|
|
105
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
106
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
107
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
108
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
109
|
+
* @param {OnBidAwardRevertedRequest} onBidAwardRevertedRequest
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
onBidAwardReverted(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardRevertedRequest: OnBidAwardRevertedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
114
|
+
/**
|
|
115
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
116
|
+
* @summary λμ°° νμ .
|
|
117
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
118
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
119
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
120
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
121
|
+
* @param {OnBidAwardedRequest} onBidAwardedRequest
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
onBidAwarded(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardedRequest: OnBidAwardedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
126
|
+
/**
|
|
127
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
128
|
+
* @summary λ°μ£ΌκΈ°κ΄ λλ μ΄μμμ κ³΅κ³ μ·¨μ.
|
|
129
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
130
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
131
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
132
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
133
|
+
* @param {OnBidCanceledRequest} onBidCanceledRequest
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
onBidCanceled(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidCanceledRequest: OnBidCanceledRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
138
|
+
/**
|
|
139
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
140
|
+
* @summary κ³΅κ³ λ§κ° β μμ°° μ μκ° λλ¬μ΅λλ€(λμ°°μλ μμ§ μ ν΄μ§μ§ μμμ΅λλ€).
|
|
141
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
142
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
143
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
144
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
145
|
+
* @param {OnBidClosedRequest} onBidClosedRequest
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
onBidClosed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidClosedRequest: OnBidClosedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
150
|
+
/**
|
|
151
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
152
|
+
* @summary μ μ°° νμ .
|
|
153
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
154
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
155
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
156
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
157
|
+
* @param {OnBidFailedRequest} onBidFailedRequest
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
onBidFailed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidFailedRequest: OnBidFailedRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
162
|
+
/**
|
|
163
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
164
|
+
* @summary μ°κ²° νμΈ λ°μ‘. **ꡬλ
ν μ μμ΅λλ€** β `POST /v2/webhook-endpoints/{endpointId}/test` κ° μ¦μ 1ν λ³΄λΌ λλ§ μ΅λλ€.
|
|
165
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
166
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
167
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
168
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
169
|
+
* @param {OnPingRequest} onPingRequest
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
onPing(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onPingRequest: OnPingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* WebhooksApi - factory interface
|
|
177
|
+
*/
|
|
178
|
+
export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
179
|
+
/**
|
|
180
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
181
|
+
* @summary μ΄μμκ° λμ°°μ λλλ Έμ΅λλ€ β μ΄λ―Έ λ°μ `bid.awarded` λ₯Ό 무ν¨λ‘ μ·¨κΈνμΈμ.
|
|
182
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
183
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
184
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
185
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
186
|
+
* @param {OnBidAwardRevertedRequest} onBidAwardRevertedRequest
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
onBidAwardReverted(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardRevertedRequest: OnBidAwardRevertedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
191
|
+
/**
|
|
192
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
193
|
+
* @summary λμ°° νμ .
|
|
194
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
195
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
196
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
197
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
198
|
+
* @param {OnBidAwardedRequest} onBidAwardedRequest
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
*/
|
|
202
|
+
onBidAwarded(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardedRequest: OnBidAwardedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
203
|
+
/**
|
|
204
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
205
|
+
* @summary λ°μ£ΌκΈ°κ΄ λλ μ΄μμμ κ³΅κ³ μ·¨μ.
|
|
206
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
207
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
208
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
209
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
210
|
+
* @param {OnBidCanceledRequest} onBidCanceledRequest
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
onBidCanceled(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidCanceledRequest: OnBidCanceledRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
215
|
+
/**
|
|
216
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
217
|
+
* @summary κ³΅κ³ λ§κ° β μμ°° μ μκ° λλ¬μ΅λλ€(λμ°°μλ μμ§ μ ν΄μ§μ§ μμμ΅λλ€).
|
|
218
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
219
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
220
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
221
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
222
|
+
* @param {OnBidClosedRequest} onBidClosedRequest
|
|
223
|
+
* @param {*} [options] Override http request option.
|
|
224
|
+
* @throws {RequiredError}
|
|
225
|
+
*/
|
|
226
|
+
onBidClosed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidClosedRequest: OnBidClosedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
227
|
+
/**
|
|
228
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
229
|
+
* @summary μ μ°° νμ .
|
|
230
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
231
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
232
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
233
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
234
|
+
* @param {OnBidFailedRequest} onBidFailedRequest
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
onBidFailed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidFailedRequest: OnBidFailedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
239
|
+
/**
|
|
240
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
241
|
+
* @summary μ°κ²° νμΈ λ°μ‘. **ꡬλ
ν μ μμ΅λλ€** β `POST /v2/webhook-endpoints/{endpointId}/test` κ° μ¦μ 1ν λ³΄λΌ λλ§ μ΅λλ€.
|
|
242
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
243
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
244
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
245
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
246
|
+
* @param {OnPingRequest} onPingRequest
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
onPing(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onPingRequest: OnPingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
251
|
+
};
|
|
252
|
+
/**
|
|
253
|
+
* WebhooksApi - object-oriented interface
|
|
254
|
+
*/
|
|
255
|
+
export declare class WebhooksApi extends BaseAPI {
|
|
256
|
+
/**
|
|
257
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
258
|
+
* @summary μ΄μμκ° λμ°°μ λλλ Έμ΅λλ€ β μ΄λ―Έ λ°μ `bid.awarded` λ₯Ό 무ν¨λ‘ μ·¨κΈνμΈμ.
|
|
259
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
260
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
261
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
262
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
263
|
+
* @param {OnBidAwardRevertedRequest} onBidAwardRevertedRequest
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
onBidAwardReverted(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardRevertedRequest: OnBidAwardRevertedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
268
|
+
/**
|
|
269
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
270
|
+
* @summary λμ°° νμ .
|
|
271
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
272
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
273
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
274
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
275
|
+
* @param {OnBidAwardedRequest} onBidAwardedRequest
|
|
276
|
+
* @param {*} [options] Override http request option.
|
|
277
|
+
* @throws {RequiredError}
|
|
278
|
+
*/
|
|
279
|
+
onBidAwarded(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidAwardedRequest: OnBidAwardedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
280
|
+
/**
|
|
281
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
282
|
+
* @summary λ°μ£ΌκΈ°κ΄ λλ μ΄μμμ κ³΅κ³ μ·¨μ.
|
|
283
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
284
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
285
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
286
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
287
|
+
* @param {OnBidCanceledRequest} onBidCanceledRequest
|
|
288
|
+
* @param {*} [options] Override http request option.
|
|
289
|
+
* @throws {RequiredError}
|
|
290
|
+
*/
|
|
291
|
+
onBidCanceled(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidCanceledRequest: OnBidCanceledRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
292
|
+
/**
|
|
293
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
294
|
+
* @summary κ³΅κ³ λ§κ° β μμ°° μ μκ° λλ¬μ΅λλ€(λμ°°μλ μμ§ μ ν΄μ§μ§ μμμ΅λλ€).
|
|
295
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
296
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
297
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
298
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
299
|
+
* @param {OnBidClosedRequest} onBidClosedRequest
|
|
300
|
+
* @param {*} [options] Override http request option.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
*/
|
|
303
|
+
onBidClosed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidClosedRequest: OnBidClosedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
304
|
+
/**
|
|
305
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
306
|
+
* @summary μ μ°° νμ .
|
|
307
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
308
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
309
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
310
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
311
|
+
* @param {OnBidFailedRequest} onBidFailedRequest
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
onBidFailed(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onBidFailedRequest: OnBidFailedRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
316
|
+
/**
|
|
317
|
+
* λ°μ‘μ User-Agent λ `cmarket-webhooks/1` μ
λλ€. **μλͺ
κ²μ¦μ μλ¬Έ λ°μ΄νΈλ‘ νμΈμ.** JSON μ νμ±ν λ€ λ€μ μ§λ ¬ννλ©΄ ν€ μμΒ·κ³΅λ°±μ΄ λ¬λΌμ Έ μλͺ
μ΄ μ΄κΈλ©λλ€. **μλͺ
κ·μ½μ [Standard Webhooks](https://www.standardwebhooks.com) μ
λλ€** β κ²μ¦μ μ§μ μ§μ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬μ λ°κΈλ°μ μν¬λ¦Ώ(`whsec_β¦`)μ κ·Έλλ‘ λκΈ°μΈμ. **μ¬μλλ at-least-once μ
λλ€.** κ°μ μ΄λ²€νΈκ° λ λ² μ¬ μ μμΌλ `webhook-id` λ‘ μ€λ³΅ μ κ±°νμΈμ. **λ³Έλ¬Έμλ μ΅μ μ λ³΄λ§ λ΄κΉλλ€.** μμΈλ μ΄λ²€νΈλ₯Ό λ°μ λ€ ν΄λΉ μ‘°ν μλν¬μΈνΈλ‘ κ°μ Έμ€μΈμ β κ°μ μ¬μ€μ λ κ³³μ΄ κ°μ νννλ©΄ κ°λΌμ§λλ€.
|
|
318
|
+
* @summary μ°κ²° νμΈ λ°μ‘. **ꡬλ
ν μ μμ΅λλ€** β `POST /v2/webhook-endpoints/{endpointId}/test` κ° μ¦μ 1ν λ³΄λΌ λλ§ μ΅λλ€.
|
|
319
|
+
* @param {string} webhookId μ΄λ²€νΈ μλ³μ. **μ¬μλμλ κ°μ κ°**μ΄λ―λ‘ μμ μΈ‘ μ€λ³΅ μ κ±° ν€λ‘ μ°μΈμ.
|
|
320
|
+
* @param {string} webhookEventType μ΄λ²€νΈ νμ
. λ³Έλ¬Έ `type` κ³Ό κ°μ΅λλ€.
|
|
321
|
+
* @param {string} webhookTimestamp μλͺ
νμμ€ν¬ν(unix μ΄). νμ¬ μκ°μμ 300μ΄ μ΄μ μ§λ μμ²μ μ¬μ μ‘μΌλ‘ λ³΄κ³ κ±°μ νμΈμ.
|
|
322
|
+
* @param {string} webhookSignature `v1,<base64 hmac-sha256>`(Standard Webhooks). μλͺ
λμμ `\"{webhook-id}.{webhook-timestamp}.{μλ¬Έ λ³Έλ¬Έ}\"` μ΄κ³ , HMAC ν€λ μν¬λ¦Ώ λ¬Έμμ΄μ΄ μλλΌ `whsec_` λ₯Ό λ λ€ base64 λμ½λν λ°μ΄νΈμ
λλ€. 곡백μΌλ‘ ꡬλΆλ μ¬λ¬ μλͺ
μ΄ μ¬ μ μμΌλ(ν€ νμ ) **νλλΌλ λ§μΌλ©΄ ν΅κ³Ό**λ‘ μ²λ¦¬νμΈμ. μ§μ ꡬννμ§ λ§κ³ κ° μΈμ΄μ `standardwebhooks` λΌμ΄λΈλ¬λ¦¬λ₯Ό μ°λ κ²μ κΆν©λλ€.
|
|
323
|
+
* @param {OnPingRequest} onPingRequest
|
|
324
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
*/
|
|
327
|
+
onPing(webhookId: string, webhookEventType: string, webhookTimestamp: string, webhookSignature: string, onPingRequest: OnPingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
328
|
+
}
|