hostinger-api-sdk 1.40.2 → 1.41.1
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 +2 -2
- package/api.ts +7281 -3521
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +10985 -8179
- package/dist/api.js +1981 -108
- 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 +2 -2
- package/dist/esm/api.d.ts +10985 -8179
- package/dist/esm/api.js +1977 -117
- 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 +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/EcommerceDiscountsApi.md +129 -0
- package/docs/EcommerceListDiscountsV1200Response.md +22 -0
- package/docs/EcommerceListProductVariantsV1200Response.md +22 -0
- package/docs/EcommerceListProductsV1200Response.md +22 -0
- package/docs/EcommerceListStoreOrdersV1200Response.md +22 -0
- package/docs/EcommerceOrdersApi.md +269 -0
- package/docs/EcommercePaymentsApi.md +114 -0
- package/docs/EcommerceProductVariantsApi.md +251 -0
- package/docs/EcommerceProductsApi.md +188 -0
- package/docs/EcommerceSalesChannelsApi.md +5 -5
- package/docs/EcommerceV1DiscountCreateDiscountRequest.md +38 -0
- package/docs/EcommerceV1DiscountDiscountResource.md +40 -0
- package/docs/EcommerceV1DiscountDiscountResponseResource.md +20 -0
- package/docs/EcommerceV1OrderCancelRequest.md +20 -0
- package/docs/EcommerceV1OrderFulfillRequest.md +26 -0
- package/docs/EcommerceV1OrderFulfillRequestItemsInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResource.md +60 -0
- package/docs/EcommerceV1OrderOrderDetailResourceBillingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInner.md +28 -0
- package/docs/EcommerceV1OrderOrderDetailResourceFulfillmentsInnerTrackingInner.md +22 -0
- package/docs/EcommerceV1OrderOrderDetailResourceItemsInner.md +36 -0
- package/docs/EcommerceV1OrderOrderDetailResourceShippingAddress.md +37 -0
- package/docs/EcommerceV1OrderOrderDetailResponseResource.md +20 -0
- package/docs/EcommerceV1OrderOrderResource.md +38 -0
- package/docs/EcommerceV1OrderOrderResponseResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderConnectLinkResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResource.md +20 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceData.md +22 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataAvailableInner.md +28 -0
- package/docs/EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInner.md +30 -0
- package/docs/EcommerceV1ProductProductDeletedResource.md +20 -0
- package/docs/EcommerceV1ProductProductDeletedResourceData.md +24 -0
- package/docs/EcommerceV1ProductProductResource.md +36 -0
- package/docs/EcommerceV1ProductProductResourceMediaInner.md +24 -0
- package/docs/EcommerceV1ProductProductResourcePriceRange.md +25 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInner.md +32 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerOptionsInner.md +22 -0
- package/docs/EcommerceV1ProductProductResourceVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1ProductProductResponseResource.md +20 -0
- package/docs/EcommerceV1ProductUpdateRequest.md +24 -0
- package/docs/EcommerceV1SalesChannelStoreRequest.md +3 -3
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequest.md +20 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInner.md +28 -0
- package/docs/EcommerceV1VariantBatchUpdateVariantsRequestVariantsInnerPricesInner.md +24 -0
- package/docs/EcommerceV1VariantCreateVariantRequest.md +30 -0
- package/docs/EcommerceV1VariantCreateVariantRequestOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantCreateVariantRequestPricesInner.md +24 -0
- package/docs/EcommerceV1VariantVariantDeletedResource.md +20 -0
- package/docs/EcommerceV1VariantVariantDeletedResourceData.md +22 -0
- package/docs/EcommerceV1VariantVariantListResponseResource.md +20 -0
- package/docs/EcommerceV1VariantVariantResource.md +32 -0
- package/docs/EcommerceV1VariantVariantResourceOptionsInner.md +22 -0
- package/docs/EcommerceV1VariantVariantResponseResource.md +20 -0
- package/docs/HostingNodeJSApi.md +2 -2
- package/docs/ReachProfilesApi.md +108 -0
- package/docs/ReachSegmentsApi.md +113 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequest.md +33 -0
- package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner.md +24 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributeResource.md +27 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterAttributesResource.md +23 -0
- package/docs/ReachV1ContactsSegmentsSegmentFilterOperatorResource.md +29 -0
- package/docs/ReachV1ContactsStoreRequest.md +2 -0
- package/docs/ReachV1ProfilesDomainsSendingDomainResource.md +29 -0
- package/docs/ReachV1ProfilesDomainsSuspendedSenderEmailResource.md +25 -0
- package/docs/ReachV1ProfilesFeaturesPlanFeatureResource.md +25 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.43.1
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -19,16 +19,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
19
19
|
});
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.
|
|
23
|
-
exports.
|
|
24
|
-
exports.
|
|
25
|
-
exports.
|
|
26
|
-
exports.
|
|
27
|
-
exports.
|
|
28
|
-
exports.
|
|
29
|
-
exports.
|
|
30
|
-
exports.
|
|
31
|
-
exports.
|
|
22
|
+
exports.HostingV1NodeJsBuildResourceStateEnum = exports.HostingV1NodeJsBuildOptionsResourceSourceTypeEnum = exports.HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = exports.HostingV1NodeJsBuildOptionsResourceAppTypeEnum = exports.HostingV1FilesFilesResourceItemsInnerTypeEnum = exports.HostingV1DomainsParkedDomainResourceTypeEnum = exports.HorizonsV1WebsitesCreateWebsiteRequestMessageInnerTypeEnum = exports.EcommerceV1StoreStoreRequestSalesChannelTypeEnum = exports.EcommerceV1StoreStoreCreationResourceSalesChannelTypeEnum = exports.EcommerceV1SalesChannelStoreRequestTypeEnum = exports.EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInnerTypeEnum = exports.EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannelTypeEnum = exports.EcommerceV1ProductUpdateRequestStatusEnum = exports.EcommerceV1ProductProductResourceStatusEnum = exports.EcommerceV1ProductProductCreationResourceProductTypeEnum = exports.EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInnerStatusEnum = exports.EcommerceV1DiscountDiscountResourceAllocationEnum = exports.EcommerceV1DiscountDiscountResourceTypeEnum = exports.EcommerceV1DiscountCreateDiscountRequestAllocationEnum = exports.EcommerceV1DiscountCreateDiscountRequestTypeEnum = exports.DomainsV1WHOISStoreRequestEntityTypeEnum = exports.DomainsV1WHOISProfileResourceEntityTypeEnum = exports.DomainsV1WHOISChangeUpdateRequestChangeForEnum = exports.DomainsV1PortfolioClaimResourceStatusEnum = exports.DomainsV1MoveMoveResourceStatusEnum = exports.DomainsV1IRTPVerificationResourceStatusEnum = exports.DomainsV1ForwardingUpdateRequestRedirectTypeEnum = exports.DomainsV1ForwardingStoreRequestRedirectTypeEnum = exports.DomainsV1ForwardingForwardingResourceRedirectTypeEnum = exports.DomainsV1DomainDomainResourceStatusEnum = exports.DomainsV1DomainDomainResourceTypeEnum = exports.DomainsV1DomainDomainExtendedResourceStatusEnum = exports.DNSV1ZoneUpdateRequestZoneInnerTypeEnum = exports.DNSV1ZoneRecordResourceTypeEnum = exports.DNSV1ZoneDestroyRequestFiltersInnerTypeEnum = exports.BillingV1SubscriptionSubscriptionResourceStatusEnum = exports.BillingV1SubscriptionCancelRequestCancelOptionEnum = exports.BillingV1SubscriptionCancelRequestReasonCodeEnum = exports.BillingV1OrderOrderResourceStatusEnum = exports.BillingV1CatalogCatalogItemPriceResourcePeriodUnitEnum = exports.AgencyHostingV1WebsitesWebsiteResourceStateEnum = exports.AgencyHostingV1WebsitesWebsiteProcessResourceStatusEnum = exports.AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum = exports.AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum = exports.AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum = exports.AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum = exports.AgencyHostingV1SetupsWebsiteSetupStatusResourceStatusEnum = exports.AgencyHostingV1SetupsCreateSetupRequestTypeEnum = exports.AgencyHostingV1PhpOptionResourceTypeEnum = exports.AgencyHostingV1PhpExtensionResourceStateEnum = void 0;
|
|
23
|
+
exports.ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInnerOperatorEnum = exports.ReachV1ContactsSegmentsProfileFilterContactsRequestSortDirectionEnum = exports.ReachV1ContactsSegmentsProfileFilterContactsRequestSortByEnum = exports.ReachV1ContactsSegmentsProfileFilterContactsRequestLogicEnum = exports.ReachV1ContactsProfileContactUpdateResourceSubscriptionStatusEnum = exports.ReachV1ContactsProfileContactResourceSourceEnum = exports.ReachV1ContactsProfileContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsFieldsStoreRequestTypeEnum = exports.ReachV1ContactsFieldsContactFieldValueResourceTypeEnum = exports.ReachV1ContactsFieldsContactFieldResourceTypeEnum = exports.ReachV1ContactsContactResourceSourceEnum = exports.ReachV1ContactsContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsContactDetailsResourceSourceEnum = exports.ReachV1ContactsContactDetailsResourceSubscriptionStatusEnum = exports.ReachV1CampaignsCampaignResourceTypeEnum = exports.ReachV1CampaignsCampaignResourceStatusEnum = exports.ReachV1CampaignsCampaignDetailsResourceTypeEnum = exports.ReachV1CampaignsCampaignDetailsResourceStatusEnum = exports.ReachV1AutomationsStepsAutomationStepResourceValueEnum = exports.ReachV1AutomationsStepsAutomationStepResourceTypeEnum = exports.ReachV1AutomationsAutomationResourceTypeEnum = exports.ReachV1AutomationsAutomationResourceStatusEnum = exports.MailV1WebhooksWebhookSecretResourceStatusEnum = exports.MailV1WebhooksWebhookSecretResourceEventsEnum = exports.MailV1WebhooksWebhookResourceStatusEnum = exports.MailV1WebhooksWebhookResourceEventsEnum = exports.MailV1WebhooksWebhookCreatedResourceStatusEnum = exports.MailV1WebhooksWebhookCreatedResourceEventsEnum = exports.MailV1SchemaUpdateWebhookRequestSchemaStatusEnum = exports.MailV1SchemaUpdateWebhookRequestSchemaEventsEnum = exports.MailV1SchemaCreateWebhookRequestSchemaStatusEnum = exports.MailV1SchemaCreateWebhookRequestSchemaEventsEnum = exports.MailV1OrdersOrderResourceStatusEnum = exports.MailV1MailboxesMailboxResourceStatusEnum = exports.MailV1LogsMailboxActionsMailboxActionLogResourceEventEnum = exports.MailV1LogsActionActionLogResourceResponseStatusEnum = exports.MailV1ApiTokensApiTokenResourceTypeEnum = exports.MailV1ApiTokensApiTokenCreatedResourceTypeEnum = exports.HostingV1WebsitesWebsiteResourceWebsiteTypeEnum = exports.HostingV1WebsitesWebsiteResourceVhostTypeEnum = exports.HostingV1NodeJsVulnerabilityResourceSeverityEnum = exports.HostingV1NodeJsStartBuildRequestSourceTypeEnum = exports.HostingV1NodeJsStartBuildRequestPackageManagerEnum = exports.HostingV1NodeJsStartBuildRequestAppTypeEnum = exports.HostingV1NodeJsStartBuildRequestNodeVersionEnum = exports.HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum = exports.HostingV1NodeJsCreateFromArchiveRequestAppTypeEnum = exports.HostingV1NodeJsCreateFromArchiveRequestNodeVersionEnum = exports.HostingV1NodeJsBuildSettingsResourcePackageManagerEnum = exports.HostingV1NodeJsBuildSettingsResourceAppTypeEnum = void 0;
|
|
24
|
+
exports.AgencyHostingCronJobsApi = exports.AgencyHostingCronJobsApiFactory = exports.AgencyHostingCronJobsApiFp = exports.AgencyHostingCronJobsApiAxiosParamCreator = exports.AgencyHostingCacheApi = exports.AgencyHostingCacheApiFactory = exports.AgencyHostingCacheApiFp = exports.AgencyHostingCacheApiAxiosParamCreator = exports.WordPressV1ThemesInstalledThemeResourceStatusEnum = exports.WordPressV1ThemesInstallThemeRequestFontEnum = exports.WordPressV1PluginsUpdateHostingerPluginRequestSlugEnum = exports.WordPressV1PluginsSuggestedPluginGroupResourceWebsiteTypeEnum = exports.WordPressV1PluginsInstalledPluginResourceStatusEnum = exports.WordPressV1MemcachedMemcachedStatusResourceStatusEnum = exports.WordPressV1MaintenanceMaintenanceStatusResourceStatusEnum = exports.WordPressV1InstallationsUpdateResourceTypeEnum = exports.WordPressV1InstallationsInstallWordPressRequestAutoUpdatesEnum = exports.WordPressV1HostingerPluginsUpdateAiOptionStatusRequestOptionEnum = exports.VPSV1VirtualMachineVirtualMachineResourceActionsLockEnum = exports.VPSV1VirtualMachineVirtualMachineResourceStateEnum = exports.VPSV1FirewallRulesStoreRequestSourceEnum = exports.VPSV1FirewallRulesStoreRequestProtocolEnum = exports.VPSV1FirewallFirewallRuleResourceProtocolEnum = exports.VPSV1FirewallFirewallRuleResourceActionEnum = exports.VPSV1DockerManagerProjectResourceStateEnum = exports.VPSV1DockerManagerContainerResourceHealthEnum = exports.VPSV1DockerManagerContainerResourceStateEnum = exports.VPSV1DockerManagerContainerPortResourceProtocolEnum = exports.VPSV1DockerManagerContainerPortResourceTypeEnum = exports.VPSV1ActionActionResourceStateEnum = exports.ReachV1ProfilesFeaturesPlanFeatureResourceFeatureEnum = exports.ReachV1ProfilesDomainsSendingDomainResourceStatusEnum = exports.ReachV1FormsFormTagResourceTypeEnum = exports.ReachV1FormsFormResourceTypeEnum = exports.ReachV1FormsFormResourceStatusEnum = exports.ReachV1FormsFormDetailsResourceTypeEnum = exports.ReachV1FormsFormDetailsResourceStatusEnum = exports.ReachV1ContactsUpdateRequestSubscriptionStatusEnum = exports.ReachV1ContactsTagsTagResourceTypeEnum = exports.ReachV1ContactsSegmentsStoreRequestConditionsInnerAttributeEnum = exports.ReachV1ContactsSegmentsStoreRequestConditionsInnerOperatorEnum = exports.ReachV1ContactsSegmentsStoreRequestLogicEnum = exports.ReachV1ContactsSegmentsSegmentationContactResourceSourceEnum = exports.ReachV1ContactsSegmentsSegmentationContactResourceSubscriptionStatusEnum = exports.ReachV1ContactsSegmentsSegmentFilterOperatorResourceInputTypeEnum = exports.ReachV1ContactsSegmentsSegmentFilterOperatorResourceOperatorEnum = exports.ReachV1ContactsSegmentsSegmentFilterAttributeResourceTypeEnum = exports.ReachV1ContactsSegmentsProfileUpdateRequestLogicEnum = exports.ReachV1ContactsSegmentsProfileStoreRequestConditionsInnerOperatorEnum = exports.ReachV1ContactsSegmentsProfileStoreRequestLogicEnum = void 0;
|
|
25
|
+
exports.BillingOrdersApiAxiosParamCreator = exports.GetCatalogItemListV1CategoryEnum = exports.BillingCatalogApi = exports.BillingCatalogApiFactory = exports.BillingCatalogApiFp = exports.BillingCatalogApiAxiosParamCreator = exports.AgencyHostingWordPressApi = exports.AgencyHostingWordPressApiFactory = exports.AgencyHostingWordPressApiFp = exports.AgencyHostingWordPressApiAxiosParamCreator = exports.ListAgencyPlanWebsitesV1WebsiteTypesEnum = exports.ListAgencyPlanWebsitesV1StatesEnum = exports.AgencyHostingWebsitesApi = exports.AgencyHostingWebsitesApiFactory = exports.AgencyHostingWebsitesApiFp = exports.AgencyHostingWebsitesApiAxiosParamCreator = exports.AgencyHostingWebsiteSetupsApi = exports.AgencyHostingWebsiteSetupsApiFactory = exports.AgencyHostingWebsiteSetupsApiFp = exports.AgencyHostingWebsiteSetupsApiAxiosParamCreator = exports.AgencyHostingPHPApi = exports.AgencyHostingPHPApiFactory = exports.AgencyHostingPHPApiFp = exports.AgencyHostingPHPApiAxiosParamCreator = exports.AgencyHostingOrdersApi = exports.AgencyHostingOrdersApiFactory = exports.AgencyHostingOrdersApiFp = exports.AgencyHostingOrdersApiAxiosParamCreator = exports.ListOrderResourceUsageMetricsV1TimeFrameHoursEnum = exports.ListAgencyPlanOrderDiskUsageMetricsV1TimeFrameDaysEnum = exports.AgencyHostingMetricsApi = exports.AgencyHostingMetricsApiFactory = exports.AgencyHostingMetricsApiFp = exports.AgencyHostingMetricsApiAxiosParamCreator = exports.AgencyHostingFilesApi = exports.AgencyHostingFilesApiFactory = exports.AgencyHostingFilesApiFp = exports.AgencyHostingFilesApiAxiosParamCreator = exports.AgencyHostingDomainsApi = exports.AgencyHostingDomainsApiFactory = exports.AgencyHostingDomainsApiFp = exports.AgencyHostingDomainsApiAxiosParamCreator = exports.AgencyHostingDatacentersApi = exports.AgencyHostingDatacentersApiFactory = exports.AgencyHostingDatacentersApiFp = exports.AgencyHostingDatacentersApiAxiosParamCreator = exports.AgencyHostingDatabasesApi = exports.AgencyHostingDatabasesApiFactory = exports.AgencyHostingDatabasesApiFp = exports.AgencyHostingDatabasesApiAxiosParamCreator = void 0;
|
|
26
|
+
exports.EcommerceDiscountsApiFactory = exports.EcommerceDiscountsApiFp = exports.EcommerceDiscountsApiAxiosParamCreator = exports.DomainsWHOISApi = exports.DomainsWHOISApiFactory = exports.DomainsWHOISApiFp = exports.DomainsWHOISApiAxiosParamCreator = exports.DomainsTransferApi = exports.DomainsTransferApiFactory = exports.DomainsTransferApiFp = exports.DomainsTransferApiAxiosParamCreator = exports.DomainsPortfolioApi = exports.DomainsPortfolioApiFactory = exports.DomainsPortfolioApiFp = exports.DomainsPortfolioApiAxiosParamCreator = exports.DomainsMoveApi = exports.DomainsMoveApiFactory = exports.DomainsMoveApiFp = exports.DomainsMoveApiAxiosParamCreator = exports.DomainsForwardingApi = exports.DomainsForwardingApiFactory = exports.DomainsForwardingApiFp = exports.DomainsForwardingApiAxiosParamCreator = exports.DomainsAvailabilityApi = exports.DomainsAvailabilityApiFactory = exports.DomainsAvailabilityApiFp = exports.DomainsAvailabilityApiAxiosParamCreator = exports.DomainAccessVerifierVerificationsApi = exports.DomainAccessVerifierVerificationsApiFactory = exports.DomainAccessVerifierVerificationsApiFp = exports.DomainAccessVerifierVerificationsApiAxiosParamCreator = exports.DNSZoneApi = exports.DNSZoneApiFactory = exports.DNSZoneApiFp = exports.DNSZoneApiAxiosParamCreator = exports.DNSSnapshotApi = exports.DNSSnapshotApiFactory = exports.DNSSnapshotApiFp = exports.DNSSnapshotApiAxiosParamCreator = exports.BillingSubscriptionsApi = exports.BillingSubscriptionsApiFactory = exports.BillingSubscriptionsApiFp = exports.BillingSubscriptionsApiAxiosParamCreator = exports.BillingPaymentMethodsApi = exports.BillingPaymentMethodsApiFactory = exports.BillingPaymentMethodsApiFp = exports.BillingPaymentMethodsApiAxiosParamCreator = exports.BillingOrdersApi = exports.BillingOrdersApiFactory = exports.BillingOrdersApiFp = void 0;
|
|
27
|
+
exports.HostingCronJobsApiFactory = exports.HostingCronJobsApiFp = exports.HostingCronJobsApiAxiosParamCreator = exports.HostingCacheApi = exports.HostingCacheApiFactory = exports.HostingCacheApiFp = exports.HostingCacheApiAxiosParamCreator = exports.HorizonsWebsitesApi = exports.HorizonsWebsitesApiFactory = exports.HorizonsWebsitesApiFp = exports.HorizonsWebsitesApiAxiosParamCreator = exports.EcommerceStoresApi = exports.EcommerceStoresApiFactory = exports.EcommerceStoresApiFp = exports.EcommerceStoresApiAxiosParamCreator = exports.EcommerceShippingApi = exports.EcommerceShippingApiFactory = exports.EcommerceShippingApiFp = exports.EcommerceShippingApiAxiosParamCreator = exports.EcommerceSalesChannelsApi = exports.EcommerceSalesChannelsApiFactory = exports.EcommerceSalesChannelsApiFp = exports.EcommerceSalesChannelsApiAxiosParamCreator = exports.ListProductsV1IncludeEnum = exports.ListProductsV1StatusEnum = exports.EcommerceProductsApi = exports.EcommerceProductsApiFactory = exports.EcommerceProductsApiFp = exports.EcommerceProductsApiAxiosParamCreator = exports.EcommerceProductVariantsApi = exports.EcommerceProductVariantsApiFactory = exports.EcommerceProductVariantsApiFp = exports.EcommerceProductVariantsApiAxiosParamCreator = exports.EcommercePaymentsApi = exports.EcommercePaymentsApiFactory = exports.EcommercePaymentsApiFp = exports.EcommercePaymentsApiAxiosParamCreator = exports.ListStoreOrdersV1FulfillmentStatusEnum = exports.ListStoreOrdersV1PaymentStatusEnum = exports.ListStoreOrdersV1StatusEnum = exports.EcommerceOrdersApi = exports.EcommerceOrdersApiFactory = exports.EcommerceOrdersApiFp = exports.EcommerceOrdersApiAxiosParamCreator = exports.EcommerceMiscellaneousApi = exports.EcommerceMiscellaneousApiFactory = exports.EcommerceMiscellaneousApiFp = exports.EcommerceMiscellaneousApiAxiosParamCreator = exports.ListDiscountsV1IsDisabledEnum = exports.EcommerceDiscountsApi = void 0;
|
|
28
|
+
exports.MailAliasesApi = exports.MailAliasesApiFactory = exports.MailAliasesApiFp = exports.MailAliasesApiAxiosParamCreator = exports.MailAPITokensApi = exports.MailAPITokensApiFactory = exports.MailAPITokensApiFp = exports.MailAPITokensApiAxiosParamCreator = exports.ListWebsitesV1WebsiteTypesEnum = exports.HostingWebsitesApi = exports.HostingWebsitesApiFactory = exports.HostingWebsitesApiFp = exports.HostingWebsitesApiAxiosParamCreator = exports.HostingRedirectsApi = exports.HostingRedirectsApiFactory = exports.HostingRedirectsApiFp = exports.HostingRedirectsApiAxiosParamCreator = exports.HostingPHPApi = exports.HostingPHPApiFactory = exports.HostingPHPApiFp = exports.HostingPHPApiAxiosParamCreator = exports.ListOrdersV1StatusesEnum = exports.HostingOrdersApi = exports.HostingOrdersApiFactory = exports.HostingOrdersApiFp = exports.HostingOrdersApiAxiosParamCreator = exports.ListNodeJsVulnerabilitiesV1SeveritiesEnum = exports.ListNodeJSBuildsV1StatesEnum = exports.HostingNodeJSApi = exports.HostingNodeJSApiFactory = exports.HostingNodeJSApiFp = exports.HostingNodeJSApiAxiosParamCreator = exports.ListWebsiteFilesAndDirectoriesV1FileTypesEnum = exports.HostingFilesApi = exports.HostingFilesApiFactory = exports.HostingFilesApiFp = exports.HostingFilesApiAxiosParamCreator = exports.HostingDomainsApi = exports.HostingDomainsApiFactory = exports.HostingDomainsApiFp = exports.HostingDomainsApiAxiosParamCreator = exports.HostingDatacentersApi = exports.HostingDatacentersApiFactory = exports.HostingDatacentersApiFp = exports.HostingDatacentersApiAxiosParamCreator = exports.HostingDatabasesApi = exports.HostingDatabasesApiFactory = exports.HostingDatabasesApiFp = exports.HostingDatabasesApiAxiosParamCreator = exports.HostingCronJobsApi = void 0;
|
|
29
|
+
exports.ListCampaignsV1TypeEnum = exports.ListCampaignsV1StatusEnum = exports.ReachCampaignsApi = exports.ReachCampaignsApiFactory = exports.ReachCampaignsApiFp = exports.ReachCampaignsApiAxiosParamCreator = exports.ListAutomationsV1SortDirectionEnum = exports.ListAutomationsV1StatusEnum = exports.ReachAutomationsApi = exports.ReachAutomationsApiFactory = exports.ReachAutomationsApiFp = exports.ReachAutomationsApiAxiosParamCreator = exports.ListWebhooksV1StatusEnum = exports.MailWebhooksApi = exports.MailWebhooksApiFactory = exports.MailWebhooksApiFp = exports.MailWebhooksApiAxiosParamCreator = exports.ListOrdersV1SortEnum = exports.ListOrdersV1StatusEnum = exports.MailOrdersApi = exports.MailOrdersApiFactory = exports.MailOrdersApiFp = exports.MailOrdersApiAxiosParamCreator = exports.ListMailboxesV1SortEnum = exports.MailMailboxesApi = exports.MailMailboxesApiFactory = exports.MailMailboxesApiFp = exports.MailMailboxesApiAxiosParamCreator = exports.ListOutboundLogsV1StatusEnum = exports.ListMailboxActionLogsV1EventEnum = exports.ListInboundLogsV1StatusEnum = exports.ListActionLogsV1StatusEnum = exports.ListAccessLogsV1ProtocolEnum = exports.ListAccessLogsV1StatusEnum = exports.MailLogsApi = exports.MailLogsApiFactory = exports.MailLogsApiFp = exports.MailLogsApiAxiosParamCreator = exports.MailForwardersApi = exports.MailForwardersApiFactory = exports.MailForwardersApiFp = exports.MailForwardersApiAxiosParamCreator = exports.MailCatchallsApi = exports.MailCatchallsApiFactory = exports.MailCatchallsApiFp = exports.MailCatchallsApiAxiosParamCreator = exports.MailAutorepliesApi = exports.MailAutorepliesApiFactory = exports.MailAutorepliesApiFp = exports.MailAutorepliesApiAxiosParamCreator = void 0;
|
|
30
|
+
exports.VPSMalwareScannerApiFp = exports.VPSMalwareScannerApiAxiosParamCreator = exports.VPSFirewallApi = exports.VPSFirewallApiFactory = exports.VPSFirewallApiFp = exports.VPSFirewallApiAxiosParamCreator = exports.VPSDockerManagerApi = exports.VPSDockerManagerApiFactory = exports.VPSDockerManagerApiFp = exports.VPSDockerManagerApiAxiosParamCreator = exports.VPSDataCentersApi = exports.VPSDataCentersApiFactory = exports.VPSDataCentersApiFp = exports.VPSDataCentersApiAxiosParamCreator = exports.VPSBackupsApi = exports.VPSBackupsApiFactory = exports.VPSBackupsApiFp = exports.VPSBackupsApiAxiosParamCreator = exports.VPSActionsApi = exports.VPSActionsApiFactory = exports.VPSActionsApiFp = exports.VPSActionsApiAxiosParamCreator = exports.ReachTagsApi = exports.ReachTagsApiFactory = exports.ReachTagsApiFp = exports.ReachTagsApiAxiosParamCreator = exports.ListProfileSegmentsV1CountTypeEnum = exports.ReachSegmentsApi = exports.ReachSegmentsApiFactory = exports.ReachSegmentsApiFp = exports.ReachSegmentsApiAxiosParamCreator = exports.ReachProfilesApi = exports.ReachProfilesApiFactory = exports.ReachProfilesApiFp = exports.ReachProfilesApiAxiosParamCreator = exports.ReachFormsApi = exports.ReachFormsApiFactory = exports.ReachFormsApiFp = exports.ReachFormsApiAxiosParamCreator = exports.ListProfileContactsV1SubscriptionStatusEnum = exports.ListContactsV1SubscriptionStatusEnum = exports.ReachContactsApi = exports.ReachContactsApiFactory = exports.ReachContactsApiFp = exports.ReachContactsApiAxiosParamCreator = exports.ReachContactFieldsApi = exports.ReachContactFieldsApiFactory = exports.ReachContactFieldsApiFp = exports.ReachContactFieldsApiAxiosParamCreator = exports.ListCampaignsV1SortDirectionEnum = void 0;
|
|
31
|
+
exports.WordPressMaintenanceApiFp = exports.WordPressMaintenanceApiAxiosParamCreator = exports.WordPressLoginApi = exports.WordPressLoginApiFactory = exports.WordPressLoginApiFp = exports.WordPressLoginApiAxiosParamCreator = exports.WordPressLiteSpeedCacheApi = exports.WordPressLiteSpeedCacheApiFactory = exports.WordPressLiteSpeedCacheApiFp = exports.WordPressLiteSpeedCacheApiAxiosParamCreator = exports.ListWordPressInstallationsV1OwnershipEnum = exports.WordPressInstallationsApi = exports.WordPressInstallationsApiFactory = exports.WordPressInstallationsApiFp = exports.WordPressInstallationsApiAxiosParamCreator = exports.ShowAIOptionStatusV1OptionEnum = exports.WordPressAIToolsApi = exports.WordPressAIToolsApiFactory = exports.WordPressAIToolsApiFp = exports.WordPressAIToolsApiAxiosParamCreator = exports.VPSVirtualMachineApi = exports.VPSVirtualMachineApiFactory = exports.VPSVirtualMachineApiFp = exports.VPSVirtualMachineApiAxiosParamCreator = exports.VPSSnapshotsApi = exports.VPSSnapshotsApiFactory = exports.VPSSnapshotsApiFp = exports.VPSSnapshotsApiAxiosParamCreator = exports.VPSRecoveryApi = exports.VPSRecoveryApiFactory = exports.VPSRecoveryApiFp = exports.VPSRecoveryApiAxiosParamCreator = exports.VPSPublicKeysApi = exports.VPSPublicKeysApiFactory = exports.VPSPublicKeysApiFp = exports.VPSPublicKeysApiAxiosParamCreator = exports.VPSPostInstallScriptsApi = exports.VPSPostInstallScriptsApiFactory = exports.VPSPostInstallScriptsApiFp = exports.VPSPostInstallScriptsApiAxiosParamCreator = exports.VPSPTRRecordsApi = exports.VPSPTRRecordsApiFactory = exports.VPSPTRRecordsApiFp = exports.VPSPTRRecordsApiAxiosParamCreator = exports.VPSOSTemplatesApi = exports.VPSOSTemplatesApiFactory = exports.VPSOSTemplatesApiFp = exports.VPSOSTemplatesApiAxiosParamCreator = exports.VPSMalwareScannerApi = exports.VPSMalwareScannerApiFactory = void 0;
|
|
32
|
+
exports.WordPressThemesApi = exports.WordPressThemesApiFactory = exports.WordPressThemesApiFp = exports.WordPressThemesApiAxiosParamCreator = exports.ListInstalledWordPressPluginsV1CategoryEnum = exports.WordPressPluginsApi = exports.WordPressPluginsApiFactory = exports.WordPressPluginsApiFp = exports.WordPressPluginsApiAxiosParamCreator = exports.WordPressObjectCacheApi = exports.WordPressObjectCacheApiFactory = exports.WordPressObjectCacheApiFp = exports.WordPressObjectCacheApiAxiosParamCreator = exports.WordPressMaintenanceApi = exports.WordPressMaintenanceApiFactory = void 0;
|
|
32
33
|
const axios_1 = require("axios");
|
|
33
34
|
// Some imports not used depending on template conditions
|
|
34
35
|
// @ts-ignore
|
|
@@ -223,10 +224,46 @@ exports.DomainsV1WHOISStoreRequestEntityTypeEnum = {
|
|
|
223
224
|
Individual: 'individual',
|
|
224
225
|
Organization: 'organization'
|
|
225
226
|
};
|
|
227
|
+
exports.EcommerceV1DiscountCreateDiscountRequestTypeEnum = {
|
|
228
|
+
Percentage: 'percentage',
|
|
229
|
+
Fixed: 'fixed',
|
|
230
|
+
FreeShipping: 'free_shipping'
|
|
231
|
+
};
|
|
232
|
+
exports.EcommerceV1DiscountCreateDiscountRequestAllocationEnum = {
|
|
233
|
+
Total: 'total',
|
|
234
|
+
Item: 'item'
|
|
235
|
+
};
|
|
236
|
+
exports.EcommerceV1DiscountDiscountResourceTypeEnum = {
|
|
237
|
+
Percentage: 'percentage',
|
|
238
|
+
Fixed: 'fixed',
|
|
239
|
+
FreeShipping: 'free_shipping'
|
|
240
|
+
};
|
|
241
|
+
exports.EcommerceV1DiscountDiscountResourceAllocationEnum = {
|
|
242
|
+
Total: 'total',
|
|
243
|
+
Item: 'item'
|
|
244
|
+
};
|
|
245
|
+
exports.EcommerceV1PaymentProviderPaymentProviderListResourceDataConnectedInnerStatusEnum = {
|
|
246
|
+
Connected: 'connected',
|
|
247
|
+
Pending: 'pending',
|
|
248
|
+
New: 'new',
|
|
249
|
+
Invalid: 'invalid'
|
|
250
|
+
};
|
|
226
251
|
exports.EcommerceV1ProductProductCreationResourceProductTypeEnum = {
|
|
227
252
|
Physical: 'physical',
|
|
228
253
|
Digital: 'digital'
|
|
229
254
|
};
|
|
255
|
+
exports.EcommerceV1ProductProductResourceStatusEnum = {
|
|
256
|
+
Draft: 'draft',
|
|
257
|
+
Proposed: 'proposed',
|
|
258
|
+
Published: 'published',
|
|
259
|
+
Rejected: 'rejected',
|
|
260
|
+
Archived: 'archived'
|
|
261
|
+
};
|
|
262
|
+
exports.EcommerceV1ProductUpdateRequestStatusEnum = {
|
|
263
|
+
Draft: 'draft',
|
|
264
|
+
Published: 'published',
|
|
265
|
+
Archived: 'archived'
|
|
266
|
+
};
|
|
230
267
|
exports.EcommerceV1SalesChannelSalesChannelCreationResourceSalesChannelTypeEnum = {
|
|
231
268
|
Builder: 'builder',
|
|
232
269
|
Horizons: 'horizons',
|
|
@@ -244,7 +281,8 @@ exports.EcommerceV1SalesChannelSalesChannelListResourceSalesChannelsInnerTypeEnu
|
|
|
244
281
|
Wordpress: 'wordpress'
|
|
245
282
|
};
|
|
246
283
|
exports.EcommerceV1SalesChannelStoreRequestTypeEnum = {
|
|
247
|
-
Custom: 'custom'
|
|
284
|
+
Custom: 'custom',
|
|
285
|
+
QuickLink: 'quick-link'
|
|
248
286
|
};
|
|
249
287
|
exports.EcommerceV1StoreStoreCreationResourceSalesChannelTypeEnum = {
|
|
250
288
|
Builder: 'builder',
|
|
@@ -619,6 +657,49 @@ exports.ReachV1ContactsProfileContactUpdateResourceSubscriptionStatusEnum = {
|
|
|
619
657
|
Confirmed: 'confirmed',
|
|
620
658
|
Pending: 'pending'
|
|
621
659
|
};
|
|
660
|
+
exports.ReachV1ContactsSegmentsProfileFilterContactsRequestLogicEnum = {
|
|
661
|
+
And: 'AND',
|
|
662
|
+
Or: 'OR'
|
|
663
|
+
};
|
|
664
|
+
exports.ReachV1ContactsSegmentsProfileFilterContactsRequestSortByEnum = {
|
|
665
|
+
Email: 'email',
|
|
666
|
+
Name: 'name',
|
|
667
|
+
Surname: 'surname',
|
|
668
|
+
Phone: 'phone',
|
|
669
|
+
SubscriptionStatus: 'subscription_status'
|
|
670
|
+
};
|
|
671
|
+
exports.ReachV1ContactsSegmentsProfileFilterContactsRequestSortDirectionEnum = {
|
|
672
|
+
Asc: 'asc',
|
|
673
|
+
Desc: 'desc'
|
|
674
|
+
};
|
|
675
|
+
exports.ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInnerOperatorEnum = {
|
|
676
|
+
Equals: 'equals',
|
|
677
|
+
NotEquals: 'not_equals',
|
|
678
|
+
Contains: 'contains',
|
|
679
|
+
NotContains: 'not_contains',
|
|
680
|
+
Gte: 'gte',
|
|
681
|
+
Lte: 'lte',
|
|
682
|
+
Exists: 'exists',
|
|
683
|
+
WithinLastDays: 'within_last_days',
|
|
684
|
+
NotWithinLastDays: 'not_within_last_days',
|
|
685
|
+
OlderThanDays: 'older_than_days',
|
|
686
|
+
Processed: 'processed',
|
|
687
|
+
NotProcessed: 'not_processed',
|
|
688
|
+
Delivered: 'delivered',
|
|
689
|
+
NotDelivered: 'not_delivered',
|
|
690
|
+
Dropped: 'dropped',
|
|
691
|
+
NotDropped: 'not_dropped',
|
|
692
|
+
Bounced: 'bounced',
|
|
693
|
+
NotBounced: 'not_bounced',
|
|
694
|
+
SoftBounced: 'soft_bounced',
|
|
695
|
+
NotSoftBounced: 'not_soft_bounced',
|
|
696
|
+
Opened: 'opened',
|
|
697
|
+
NotOpened: 'not_opened',
|
|
698
|
+
Clicked: 'clicked',
|
|
699
|
+
NotClicked: 'not_clicked',
|
|
700
|
+
Unsubscribed: 'unsubscribed',
|
|
701
|
+
NotUnsubscribed: 'not_unsubscribed'
|
|
702
|
+
};
|
|
622
703
|
exports.ReachV1ContactsSegmentsProfileStoreRequestLogicEnum = {
|
|
623
704
|
And: 'AND',
|
|
624
705
|
Or: 'OR'
|
|
@@ -655,6 +736,50 @@ exports.ReachV1ContactsSegmentsProfileUpdateRequestLogicEnum = {
|
|
|
655
736
|
And: 'AND',
|
|
656
737
|
Or: 'OR'
|
|
657
738
|
};
|
|
739
|
+
exports.ReachV1ContactsSegmentsSegmentFilterAttributeResourceTypeEnum = {
|
|
740
|
+
Contacts: 'contacts',
|
|
741
|
+
ContactMetadata: 'contact_metadata',
|
|
742
|
+
CampaignEvents: 'campaign_events',
|
|
743
|
+
ContactTags: 'contact_tags',
|
|
744
|
+
Campaigns: 'campaigns',
|
|
745
|
+
OptInMethod: 'opt_in_method',
|
|
746
|
+
ContactFieldValues: 'contact_field_values',
|
|
747
|
+
ContactFieldSelections: 'contact_field_selections'
|
|
748
|
+
};
|
|
749
|
+
exports.ReachV1ContactsSegmentsSegmentFilterOperatorResourceOperatorEnum = {
|
|
750
|
+
Equals: 'equals',
|
|
751
|
+
NotEquals: 'not_equals',
|
|
752
|
+
Contains: 'contains',
|
|
753
|
+
NotContains: 'not_contains',
|
|
754
|
+
Gte: 'gte',
|
|
755
|
+
Lte: 'lte',
|
|
756
|
+
Exists: 'exists',
|
|
757
|
+
WithinLastDays: 'within_last_days',
|
|
758
|
+
NotWithinLastDays: 'not_within_last_days',
|
|
759
|
+
OlderThanDays: 'older_than_days',
|
|
760
|
+
Processed: 'processed',
|
|
761
|
+
NotProcessed: 'not_processed',
|
|
762
|
+
Delivered: 'delivered',
|
|
763
|
+
NotDelivered: 'not_delivered',
|
|
764
|
+
Dropped: 'dropped',
|
|
765
|
+
NotDropped: 'not_dropped',
|
|
766
|
+
Bounced: 'bounced',
|
|
767
|
+
NotBounced: 'not_bounced',
|
|
768
|
+
SoftBounced: 'soft_bounced',
|
|
769
|
+
NotSoftBounced: 'not_soft_bounced',
|
|
770
|
+
Opened: 'opened',
|
|
771
|
+
NotOpened: 'not_opened',
|
|
772
|
+
Clicked: 'clicked',
|
|
773
|
+
NotClicked: 'not_clicked',
|
|
774
|
+
Unsubscribed: 'unsubscribed',
|
|
775
|
+
NotUnsubscribed: 'not_unsubscribed'
|
|
776
|
+
};
|
|
777
|
+
exports.ReachV1ContactsSegmentsSegmentFilterOperatorResourceInputTypeEnum = {
|
|
778
|
+
Text: 'text',
|
|
779
|
+
Number: 'number',
|
|
780
|
+
Date: 'date',
|
|
781
|
+
Select: 'select'
|
|
782
|
+
};
|
|
658
783
|
exports.ReachV1ContactsSegmentsSegmentationContactResourceSubscriptionStatusEnum = {
|
|
659
784
|
Subscribed: 'subscribed',
|
|
660
785
|
Unsubscribed: 'unsubscribed',
|
|
@@ -756,6 +881,21 @@ exports.ReachV1FormsFormTagResourceTypeEnum = {
|
|
|
756
881
|
Import: 'import',
|
|
757
882
|
System: 'system'
|
|
758
883
|
};
|
|
884
|
+
exports.ReachV1ProfilesDomainsSendingDomainResourceStatusEnum = {
|
|
885
|
+
Active: 'active',
|
|
886
|
+
Inactive: 'inactive',
|
|
887
|
+
Pending: 'pending',
|
|
888
|
+
Blocked: 'blocked'
|
|
889
|
+
};
|
|
890
|
+
exports.ReachV1ProfilesFeaturesPlanFeatureResourceFeatureEnum = {
|
|
891
|
+
AutomationActivation: 'AutomationActivation',
|
|
892
|
+
SmartSending: 'SmartSending',
|
|
893
|
+
AiGenerateSubjectLines: 'AiGenerateSubjectLines',
|
|
894
|
+
TemplateCheckerAnalysis: 'TemplateCheckerAnalysis',
|
|
895
|
+
RemoveSignature: 'RemoveSignature',
|
|
896
|
+
Collaborators: 'Collaborators',
|
|
897
|
+
HtmlCodeEditor: 'HtmlCodeEditor'
|
|
898
|
+
};
|
|
759
899
|
exports.VPSV1ActionActionResourceStateEnum = {
|
|
760
900
|
Success: 'success',
|
|
761
901
|
Error: 'error',
|
|
@@ -8546,6 +8686,216 @@ class DomainsWHOISApi extends base_1.BaseAPI {
|
|
|
8546
8686
|
}
|
|
8547
8687
|
}
|
|
8548
8688
|
exports.DomainsWHOISApi = DomainsWHOISApi;
|
|
8689
|
+
/**
|
|
8690
|
+
* EcommerceDiscountsApi - axios parameter creator
|
|
8691
|
+
* @export
|
|
8692
|
+
*/
|
|
8693
|
+
const EcommerceDiscountsApiAxiosParamCreator = function (configuration) {
|
|
8694
|
+
return {
|
|
8695
|
+
/**
|
|
8696
|
+
* Create a discount for a store. Fixed discounts take an amount in the smallest currency unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100. Free-shipping discounts ignore value. Returns the created discount.
|
|
8697
|
+
* @summary Create a discount
|
|
8698
|
+
* @param {string} storeId The ID of the store to create the discount for.
|
|
8699
|
+
* @param {EcommerceV1DiscountCreateDiscountRequest} ecommerceV1DiscountCreateDiscountRequest
|
|
8700
|
+
* @param {*} [options] Override http request option.
|
|
8701
|
+
* @throws {RequiredError}
|
|
8702
|
+
*/
|
|
8703
|
+
createADiscountV1: (storeId_1, ecommerceV1DiscountCreateDiscountRequest_1, ...args_1) => __awaiter(this, [storeId_1, ecommerceV1DiscountCreateDiscountRequest_1, ...args_1], void 0, function* (storeId, ecommerceV1DiscountCreateDiscountRequest, options = {}) {
|
|
8704
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
8705
|
+
(0, common_1.assertParamExists)('createADiscountV1', 'storeId', storeId);
|
|
8706
|
+
// verify required parameter 'ecommerceV1DiscountCreateDiscountRequest' is not null or undefined
|
|
8707
|
+
(0, common_1.assertParamExists)('createADiscountV1', 'ecommerceV1DiscountCreateDiscountRequest', ecommerceV1DiscountCreateDiscountRequest);
|
|
8708
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/discounts`
|
|
8709
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
8710
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8711
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
8712
|
+
let baseOptions;
|
|
8713
|
+
if (configuration) {
|
|
8714
|
+
baseOptions = configuration.baseOptions;
|
|
8715
|
+
}
|
|
8716
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
8717
|
+
const localVarHeaderParameter = {};
|
|
8718
|
+
const localVarQueryParameter = {};
|
|
8719
|
+
// authentication apiToken required
|
|
8720
|
+
// http bearer authentication required
|
|
8721
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
8722
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
8723
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8724
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8725
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8726
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1DiscountCreateDiscountRequest, localVarRequestOptions, configuration);
|
|
8727
|
+
return {
|
|
8728
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8729
|
+
options: localVarRequestOptions,
|
|
8730
|
+
};
|
|
8731
|
+
}),
|
|
8732
|
+
/**
|
|
8733
|
+
* List a store\'s discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100.
|
|
8734
|
+
* @summary List discounts
|
|
8735
|
+
* @param {string} storeId The ID of the store to list discounts for.
|
|
8736
|
+
* @param {string} [q] Free-text search over discount code and name.
|
|
8737
|
+
* @param {ListDiscountsV1IsDisabledEnum} [isDisabled] Filter by disabled state.
|
|
8738
|
+
* @param {number} [page] Page number
|
|
8739
|
+
* @param {*} [options] Override http request option.
|
|
8740
|
+
* @throws {RequiredError}
|
|
8741
|
+
*/
|
|
8742
|
+
listDiscountsV1: (storeId_1, q_1, isDisabled_1, page_1, ...args_1) => __awaiter(this, [storeId_1, q_1, isDisabled_1, page_1, ...args_1], void 0, function* (storeId, q, isDisabled, page, options = {}) {
|
|
8743
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
8744
|
+
(0, common_1.assertParamExists)('listDiscountsV1', 'storeId', storeId);
|
|
8745
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/discounts`
|
|
8746
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
8747
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8748
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
8749
|
+
let baseOptions;
|
|
8750
|
+
if (configuration) {
|
|
8751
|
+
baseOptions = configuration.baseOptions;
|
|
8752
|
+
}
|
|
8753
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
8754
|
+
const localVarHeaderParameter = {};
|
|
8755
|
+
const localVarQueryParameter = {};
|
|
8756
|
+
// authentication apiToken required
|
|
8757
|
+
// http bearer authentication required
|
|
8758
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
8759
|
+
if (q !== undefined) {
|
|
8760
|
+
localVarQueryParameter['q'] = q;
|
|
8761
|
+
}
|
|
8762
|
+
if (isDisabled !== undefined) {
|
|
8763
|
+
localVarQueryParameter['is_disabled'] = isDisabled;
|
|
8764
|
+
}
|
|
8765
|
+
if (page !== undefined) {
|
|
8766
|
+
localVarQueryParameter['page'] = page;
|
|
8767
|
+
}
|
|
8768
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8769
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8770
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8771
|
+
return {
|
|
8772
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8773
|
+
options: localVarRequestOptions,
|
|
8774
|
+
};
|
|
8775
|
+
}),
|
|
8776
|
+
};
|
|
8777
|
+
};
|
|
8778
|
+
exports.EcommerceDiscountsApiAxiosParamCreator = EcommerceDiscountsApiAxiosParamCreator;
|
|
8779
|
+
/**
|
|
8780
|
+
* EcommerceDiscountsApi - functional programming interface
|
|
8781
|
+
* @export
|
|
8782
|
+
*/
|
|
8783
|
+
const EcommerceDiscountsApiFp = function (configuration) {
|
|
8784
|
+
const localVarAxiosParamCreator = (0, exports.EcommerceDiscountsApiAxiosParamCreator)(configuration);
|
|
8785
|
+
return {
|
|
8786
|
+
/**
|
|
8787
|
+
* Create a discount for a store. Fixed discounts take an amount in the smallest currency unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100. Free-shipping discounts ignore value. Returns the created discount.
|
|
8788
|
+
* @summary Create a discount
|
|
8789
|
+
* @param {string} storeId The ID of the store to create the discount for.
|
|
8790
|
+
* @param {EcommerceV1DiscountCreateDiscountRequest} ecommerceV1DiscountCreateDiscountRequest
|
|
8791
|
+
* @param {*} [options] Override http request option.
|
|
8792
|
+
* @throws {RequiredError}
|
|
8793
|
+
*/
|
|
8794
|
+
createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options) {
|
|
8795
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8796
|
+
var _a, _b;
|
|
8797
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options);
|
|
8798
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceDiscountsApi.createADiscountV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
8799
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8800
|
+
});
|
|
8801
|
+
},
|
|
8802
|
+
/**
|
|
8803
|
+
* List a store\'s discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100.
|
|
8804
|
+
* @summary List discounts
|
|
8805
|
+
* @param {string} storeId The ID of the store to list discounts for.
|
|
8806
|
+
* @param {string} [q] Free-text search over discount code and name.
|
|
8807
|
+
* @param {ListDiscountsV1IsDisabledEnum} [isDisabled] Filter by disabled state.
|
|
8808
|
+
* @param {number} [page] Page number
|
|
8809
|
+
* @param {*} [options] Override http request option.
|
|
8810
|
+
* @throws {RequiredError}
|
|
8811
|
+
*/
|
|
8812
|
+
listDiscountsV1(storeId, q, isDisabled, page, options) {
|
|
8813
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
8814
|
+
var _a, _b;
|
|
8815
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listDiscountsV1(storeId, q, isDisabled, page, options);
|
|
8816
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceDiscountsApi.listDiscountsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
8817
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8818
|
+
});
|
|
8819
|
+
},
|
|
8820
|
+
};
|
|
8821
|
+
};
|
|
8822
|
+
exports.EcommerceDiscountsApiFp = EcommerceDiscountsApiFp;
|
|
8823
|
+
/**
|
|
8824
|
+
* EcommerceDiscountsApi - factory interface
|
|
8825
|
+
* @export
|
|
8826
|
+
*/
|
|
8827
|
+
const EcommerceDiscountsApiFactory = function (configuration, basePath, axios) {
|
|
8828
|
+
const localVarFp = (0, exports.EcommerceDiscountsApiFp)(configuration);
|
|
8829
|
+
return {
|
|
8830
|
+
/**
|
|
8831
|
+
* Create a discount for a store. Fixed discounts take an amount in the smallest currency unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100. Free-shipping discounts ignore value. Returns the created discount.
|
|
8832
|
+
* @summary Create a discount
|
|
8833
|
+
* @param {string} storeId The ID of the store to create the discount for.
|
|
8834
|
+
* @param {EcommerceV1DiscountCreateDiscountRequest} ecommerceV1DiscountCreateDiscountRequest
|
|
8835
|
+
* @param {*} [options] Override http request option.
|
|
8836
|
+
* @throws {RequiredError}
|
|
8837
|
+
*/
|
|
8838
|
+
createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options) {
|
|
8839
|
+
return localVarFp.createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options).then((request) => request(axios, basePath));
|
|
8840
|
+
},
|
|
8841
|
+
/**
|
|
8842
|
+
* List a store\'s discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100.
|
|
8843
|
+
* @summary List discounts
|
|
8844
|
+
* @param {string} storeId The ID of the store to list discounts for.
|
|
8845
|
+
* @param {string} [q] Free-text search over discount code and name.
|
|
8846
|
+
* @param {ListDiscountsV1IsDisabledEnum} [isDisabled] Filter by disabled state.
|
|
8847
|
+
* @param {number} [page] Page number
|
|
8848
|
+
* @param {*} [options] Override http request option.
|
|
8849
|
+
* @throws {RequiredError}
|
|
8850
|
+
*/
|
|
8851
|
+
listDiscountsV1(storeId, q, isDisabled, page, options) {
|
|
8852
|
+
return localVarFp.listDiscountsV1(storeId, q, isDisabled, page, options).then((request) => request(axios, basePath));
|
|
8853
|
+
},
|
|
8854
|
+
};
|
|
8855
|
+
};
|
|
8856
|
+
exports.EcommerceDiscountsApiFactory = EcommerceDiscountsApiFactory;
|
|
8857
|
+
/**
|
|
8858
|
+
* EcommerceDiscountsApi - object-oriented interface
|
|
8859
|
+
* @export
|
|
8860
|
+
* @class EcommerceDiscountsApi
|
|
8861
|
+
* @extends {BaseAPI}
|
|
8862
|
+
*/
|
|
8863
|
+
class EcommerceDiscountsApi extends base_1.BaseAPI {
|
|
8864
|
+
/**
|
|
8865
|
+
* Create a discount for a store. Fixed discounts take an amount in the smallest currency unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100. Free-shipping discounts ignore value. Returns the created discount.
|
|
8866
|
+
* @summary Create a discount
|
|
8867
|
+
* @param {string} storeId The ID of the store to create the discount for.
|
|
8868
|
+
* @param {EcommerceV1DiscountCreateDiscountRequest} ecommerceV1DiscountCreateDiscountRequest
|
|
8869
|
+
* @param {*} [options] Override http request option.
|
|
8870
|
+
* @throws {RequiredError}
|
|
8871
|
+
* @memberof EcommerceDiscountsApi
|
|
8872
|
+
*/
|
|
8873
|
+
createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options) {
|
|
8874
|
+
return (0, exports.EcommerceDiscountsApiFp)(this.configuration).createADiscountV1(storeId, ecommerceV1DiscountCreateDiscountRequest, options).then((request) => request(this.axios, this.basePath));
|
|
8875
|
+
}
|
|
8876
|
+
/**
|
|
8877
|
+
* List a store\'s discounts. Filter by free text over code and name, or by disabled state. Amounts for fixed discounts are integers in the smallest currency unit; percentage discounts carry a whole-number value between 1 and 100.
|
|
8878
|
+
* @summary List discounts
|
|
8879
|
+
* @param {string} storeId The ID of the store to list discounts for.
|
|
8880
|
+
* @param {string} [q] Free-text search over discount code and name.
|
|
8881
|
+
* @param {ListDiscountsV1IsDisabledEnum} [isDisabled] Filter by disabled state.
|
|
8882
|
+
* @param {number} [page] Page number
|
|
8883
|
+
* @param {*} [options] Override http request option.
|
|
8884
|
+
* @throws {RequiredError}
|
|
8885
|
+
* @memberof EcommerceDiscountsApi
|
|
8886
|
+
*/
|
|
8887
|
+
listDiscountsV1(storeId, q, isDisabled, page, options) {
|
|
8888
|
+
return (0, exports.EcommerceDiscountsApiFp)(this.configuration).listDiscountsV1(storeId, q, isDisabled, page, options).then((request) => request(this.axios, this.basePath));
|
|
8889
|
+
}
|
|
8890
|
+
}
|
|
8891
|
+
exports.EcommerceDiscountsApi = EcommerceDiscountsApi;
|
|
8892
|
+
/**
|
|
8893
|
+
* @export
|
|
8894
|
+
*/
|
|
8895
|
+
exports.ListDiscountsV1IsDisabledEnum = {
|
|
8896
|
+
True: 'true',
|
|
8897
|
+
False: 'false'
|
|
8898
|
+
};
|
|
8549
8899
|
/**
|
|
8550
8900
|
* EcommerceMiscellaneousApi - axios parameter creator
|
|
8551
8901
|
* @export
|
|
@@ -8646,26 +8996,30 @@ class EcommerceMiscellaneousApi extends base_1.BaseAPI {
|
|
|
8646
8996
|
}
|
|
8647
8997
|
exports.EcommerceMiscellaneousApi = EcommerceMiscellaneousApi;
|
|
8648
8998
|
/**
|
|
8649
|
-
*
|
|
8999
|
+
* EcommerceOrdersApi - axios parameter creator
|
|
8650
9000
|
* @export
|
|
8651
9001
|
*/
|
|
8652
|
-
const
|
|
9002
|
+
const EcommerceOrdersApiAxiosParamCreator = function (configuration) {
|
|
8653
9003
|
return {
|
|
8654
9004
|
/**
|
|
8655
|
-
*
|
|
8656
|
-
* @summary
|
|
8657
|
-
* @param {string} storeId The ID of the store
|
|
8658
|
-
* @param {
|
|
9005
|
+
* Cancel the order and optionally email the customer. Returns the updated order summary.
|
|
9006
|
+
* @summary Cancel an order
|
|
9007
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9008
|
+
* @param {string} orderId The ID of the order to cancel.
|
|
9009
|
+
* @param {EcommerceV1OrderCancelRequest} ecommerceV1OrderCancelRequest
|
|
8659
9010
|
* @param {*} [options] Override http request option.
|
|
8660
9011
|
* @throws {RequiredError}
|
|
8661
9012
|
*/
|
|
8662
|
-
|
|
9013
|
+
cancelAnOrderV1: (storeId_1, orderId_1, ecommerceV1OrderCancelRequest_1, ...args_1) => __awaiter(this, [storeId_1, orderId_1, ecommerceV1OrderCancelRequest_1, ...args_1], void 0, function* (storeId, orderId, ecommerceV1OrderCancelRequest, options = {}) {
|
|
8663
9014
|
// verify required parameter 'storeId' is not null or undefined
|
|
8664
|
-
(0, common_1.assertParamExists)('
|
|
8665
|
-
// verify required parameter '
|
|
8666
|
-
(0, common_1.assertParamExists)('
|
|
8667
|
-
|
|
8668
|
-
|
|
9015
|
+
(0, common_1.assertParamExists)('cancelAnOrderV1', 'storeId', storeId);
|
|
9016
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
9017
|
+
(0, common_1.assertParamExists)('cancelAnOrderV1', 'orderId', orderId);
|
|
9018
|
+
// verify required parameter 'ecommerceV1OrderCancelRequest' is not null or undefined
|
|
9019
|
+
(0, common_1.assertParamExists)('cancelAnOrderV1', 'ecommerceV1OrderCancelRequest', ecommerceV1OrderCancelRequest);
|
|
9020
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/cancel`
|
|
9021
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9022
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
8669
9023
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
8670
9024
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
8671
9025
|
let baseOptions;
|
|
@@ -8682,83 +9036,1044 @@ const EcommercePaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
8682
9036
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
8683
9037
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8684
9038
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
8685
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
9039
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1OrderCancelRequest, localVarRequestOptions, configuration);
|
|
8686
9040
|
return {
|
|
8687
9041
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
8688
9042
|
options: localVarRequestOptions,
|
|
8689
9043
|
};
|
|
8690
9044
|
}),
|
|
8691
|
-
};
|
|
8692
|
-
};
|
|
8693
|
-
exports.EcommercePaymentsApiAxiosParamCreator = EcommercePaymentsApiAxiosParamCreator;
|
|
8694
|
-
/**
|
|
8695
|
-
* EcommercePaymentsApi - functional programming interface
|
|
8696
|
-
* @export
|
|
8697
|
-
*/
|
|
8698
|
-
const EcommercePaymentsApiFp = function (configuration) {
|
|
8699
|
-
const localVarAxiosParamCreator = (0, exports.EcommercePaymentsApiAxiosParamCreator)(configuration);
|
|
8700
|
-
return {
|
|
8701
9045
|
/**
|
|
8702
|
-
*
|
|
8703
|
-
* @summary
|
|
8704
|
-
* @param {string} storeId The ID of the store
|
|
8705
|
-
* @param {
|
|
9046
|
+
* Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil every remaining unfulfilled item. Returns the updated order summary.
|
|
9047
|
+
* @summary Fulfil an order
|
|
9048
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9049
|
+
* @param {string} orderId The ID of the order to fulfil.
|
|
9050
|
+
* @param {EcommerceV1OrderFulfillRequest} ecommerceV1OrderFulfillRequest
|
|
8706
9051
|
* @param {*} [options] Override http request option.
|
|
8707
9052
|
* @throws {RequiredError}
|
|
8708
9053
|
*/
|
|
8709
|
-
|
|
8710
|
-
|
|
8711
|
-
|
|
8712
|
-
|
|
8713
|
-
|
|
8714
|
-
|
|
8715
|
-
|
|
8716
|
-
|
|
8717
|
-
|
|
8718
|
-
};
|
|
8719
|
-
|
|
8720
|
-
|
|
8721
|
-
|
|
9054
|
+
fulfilAnOrderV1: (storeId_1, orderId_1, ecommerceV1OrderFulfillRequest_1, ...args_1) => __awaiter(this, [storeId_1, orderId_1, ecommerceV1OrderFulfillRequest_1, ...args_1], void 0, function* (storeId, orderId, ecommerceV1OrderFulfillRequest, options = {}) {
|
|
9055
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9056
|
+
(0, common_1.assertParamExists)('fulfilAnOrderV1', 'storeId', storeId);
|
|
9057
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
9058
|
+
(0, common_1.assertParamExists)('fulfilAnOrderV1', 'orderId', orderId);
|
|
9059
|
+
// verify required parameter 'ecommerceV1OrderFulfillRequest' is not null or undefined
|
|
9060
|
+
(0, common_1.assertParamExists)('fulfilAnOrderV1', 'ecommerceV1OrderFulfillRequest', ecommerceV1OrderFulfillRequest);
|
|
9061
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/fulfill`
|
|
9062
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9063
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
9064
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9065
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9066
|
+
let baseOptions;
|
|
9067
|
+
if (configuration) {
|
|
9068
|
+
baseOptions = configuration.baseOptions;
|
|
9069
|
+
}
|
|
9070
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
9071
|
+
const localVarHeaderParameter = {};
|
|
9072
|
+
const localVarQueryParameter = {};
|
|
9073
|
+
// authentication apiToken required
|
|
9074
|
+
// http bearer authentication required
|
|
9075
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9076
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9077
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9078
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9079
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9080
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1OrderFulfillRequest, localVarRequestOptions, configuration);
|
|
9081
|
+
return {
|
|
9082
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9083
|
+
options: localVarRequestOptions,
|
|
9084
|
+
};
|
|
9085
|
+
}),
|
|
9086
|
+
/**
|
|
9087
|
+
* List a store\'s orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments.
|
|
9088
|
+
* @summary List store orders
|
|
9089
|
+
* @param {string} storeId The ID of the store to list orders for.
|
|
9090
|
+
* @param {Array<ListStoreOrdersV1StatusEnum>} [status] Order statuses to include.
|
|
9091
|
+
* @param {Array<ListStoreOrdersV1PaymentStatusEnum>} [paymentStatus] Payment statuses to include. A paid order is \"captured\".
|
|
9092
|
+
* @param {Array<ListStoreOrdersV1FulfillmentStatusEnum>} [fulfillmentStatus] Fulfilment statuses to include.
|
|
9093
|
+
* @param {string} [email] Customer email, matched exactly.
|
|
9094
|
+
* @param {string} [displayId] The order number the merchant and customer see.
|
|
9095
|
+
* @param {string} [q] Free-text search over customer name, email, order number and line items.
|
|
9096
|
+
* @param {string} [createdAtFrom] Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC).
|
|
9097
|
+
* @param {string} [createdAtTo] Latest creation time to include, inclusive. A bare date covers that whole day.
|
|
9098
|
+
* @param {number} [page] Page number
|
|
9099
|
+
* @param {*} [options] Override http request option.
|
|
9100
|
+
* @throws {RequiredError}
|
|
9101
|
+
*/
|
|
9102
|
+
listStoreOrdersV1: (storeId_1, status_1, paymentStatus_1, fulfillmentStatus_1, email_1, displayId_1, q_1, createdAtFrom_1, createdAtTo_1, page_1, ...args_1) => __awaiter(this, [storeId_1, status_1, paymentStatus_1, fulfillmentStatus_1, email_1, displayId_1, q_1, createdAtFrom_1, createdAtTo_1, page_1, ...args_1], void 0, function* (storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options = {}) {
|
|
9103
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9104
|
+
(0, common_1.assertParamExists)('listStoreOrdersV1', 'storeId', storeId);
|
|
9105
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/orders`
|
|
9106
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
9107
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9108
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9109
|
+
let baseOptions;
|
|
9110
|
+
if (configuration) {
|
|
9111
|
+
baseOptions = configuration.baseOptions;
|
|
9112
|
+
}
|
|
9113
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
9114
|
+
const localVarHeaderParameter = {};
|
|
9115
|
+
const localVarQueryParameter = {};
|
|
9116
|
+
// authentication apiToken required
|
|
9117
|
+
// http bearer authentication required
|
|
9118
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9119
|
+
if (status) {
|
|
9120
|
+
localVarQueryParameter['status'] = status;
|
|
9121
|
+
}
|
|
9122
|
+
if (paymentStatus) {
|
|
9123
|
+
localVarQueryParameter['payment_status'] = paymentStatus;
|
|
9124
|
+
}
|
|
9125
|
+
if (fulfillmentStatus) {
|
|
9126
|
+
localVarQueryParameter['fulfillment_status'] = fulfillmentStatus;
|
|
9127
|
+
}
|
|
9128
|
+
if (email !== undefined) {
|
|
9129
|
+
localVarQueryParameter['email'] = email;
|
|
9130
|
+
}
|
|
9131
|
+
if (displayId !== undefined) {
|
|
9132
|
+
localVarQueryParameter['display_id'] = displayId;
|
|
9133
|
+
}
|
|
9134
|
+
if (q !== undefined) {
|
|
9135
|
+
localVarQueryParameter['q'] = q;
|
|
9136
|
+
}
|
|
9137
|
+
if (createdAtFrom !== undefined) {
|
|
9138
|
+
localVarQueryParameter['created_at_from'] = createdAtFrom;
|
|
9139
|
+
}
|
|
9140
|
+
if (createdAtTo !== undefined) {
|
|
9141
|
+
localVarQueryParameter['created_at_to'] = createdAtTo;
|
|
9142
|
+
}
|
|
9143
|
+
if (page !== undefined) {
|
|
9144
|
+
localVarQueryParameter['page'] = page;
|
|
9145
|
+
}
|
|
9146
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9147
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9148
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9149
|
+
return {
|
|
9150
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9151
|
+
options: localVarRequestOptions,
|
|
9152
|
+
};
|
|
9153
|
+
}),
|
|
9154
|
+
/**
|
|
9155
|
+
* Retrieve one order in full: line items (each with the id the fulfil endpoint needs), addresses, the totals breakdown and fulfilments with tracking. Amounts are in the smallest currency unit.
|
|
9156
|
+
* @summary Retrieve an order
|
|
9157
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9158
|
+
* @param {string} orderId The ID of the order to retrieve.
|
|
9159
|
+
* @param {*} [options] Override http request option.
|
|
9160
|
+
* @throws {RequiredError}
|
|
9161
|
+
*/
|
|
9162
|
+
retrieveAnOrderV1: (storeId_1, orderId_1, ...args_1) => __awaiter(this, [storeId_1, orderId_1, ...args_1], void 0, function* (storeId, orderId, options = {}) {
|
|
9163
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9164
|
+
(0, common_1.assertParamExists)('retrieveAnOrderV1', 'storeId', storeId);
|
|
9165
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
9166
|
+
(0, common_1.assertParamExists)('retrieveAnOrderV1', 'orderId', orderId);
|
|
9167
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/orders/{order_id}`
|
|
9168
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9169
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
9170
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9171
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9172
|
+
let baseOptions;
|
|
9173
|
+
if (configuration) {
|
|
9174
|
+
baseOptions = configuration.baseOptions;
|
|
9175
|
+
}
|
|
9176
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
9177
|
+
const localVarHeaderParameter = {};
|
|
9178
|
+
const localVarQueryParameter = {};
|
|
9179
|
+
// authentication apiToken required
|
|
9180
|
+
// http bearer authentication required
|
|
9181
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9182
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9183
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9184
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9185
|
+
return {
|
|
9186
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9187
|
+
options: localVarRequestOptions,
|
|
9188
|
+
};
|
|
9189
|
+
}),
|
|
9190
|
+
};
|
|
9191
|
+
};
|
|
9192
|
+
exports.EcommerceOrdersApiAxiosParamCreator = EcommerceOrdersApiAxiosParamCreator;
|
|
9193
|
+
/**
|
|
9194
|
+
* EcommerceOrdersApi - functional programming interface
|
|
9195
|
+
* @export
|
|
9196
|
+
*/
|
|
9197
|
+
const EcommerceOrdersApiFp = function (configuration) {
|
|
9198
|
+
const localVarAxiosParamCreator = (0, exports.EcommerceOrdersApiAxiosParamCreator)(configuration);
|
|
9199
|
+
return {
|
|
9200
|
+
/**
|
|
9201
|
+
* Cancel the order and optionally email the customer. Returns the updated order summary.
|
|
9202
|
+
* @summary Cancel an order
|
|
9203
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9204
|
+
* @param {string} orderId The ID of the order to cancel.
|
|
9205
|
+
* @param {EcommerceV1OrderCancelRequest} ecommerceV1OrderCancelRequest
|
|
9206
|
+
* @param {*} [options] Override http request option.
|
|
9207
|
+
* @throws {RequiredError}
|
|
9208
|
+
*/
|
|
9209
|
+
cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options) {
|
|
9210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9211
|
+
var _a, _b;
|
|
9212
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options);
|
|
9213
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceOrdersApi.cancelAnOrderV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9214
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9215
|
+
});
|
|
9216
|
+
},
|
|
9217
|
+
/**
|
|
9218
|
+
* Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil every remaining unfulfilled item. Returns the updated order summary.
|
|
9219
|
+
* @summary Fulfil an order
|
|
9220
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9221
|
+
* @param {string} orderId The ID of the order to fulfil.
|
|
9222
|
+
* @param {EcommerceV1OrderFulfillRequest} ecommerceV1OrderFulfillRequest
|
|
9223
|
+
* @param {*} [options] Override http request option.
|
|
9224
|
+
* @throws {RequiredError}
|
|
9225
|
+
*/
|
|
9226
|
+
fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options) {
|
|
9227
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9228
|
+
var _a, _b;
|
|
9229
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options);
|
|
9230
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceOrdersApi.fulfilAnOrderV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9231
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9232
|
+
});
|
|
9233
|
+
},
|
|
9234
|
+
/**
|
|
9235
|
+
* List a store\'s orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments.
|
|
9236
|
+
* @summary List store orders
|
|
9237
|
+
* @param {string} storeId The ID of the store to list orders for.
|
|
9238
|
+
* @param {Array<ListStoreOrdersV1StatusEnum>} [status] Order statuses to include.
|
|
9239
|
+
* @param {Array<ListStoreOrdersV1PaymentStatusEnum>} [paymentStatus] Payment statuses to include. A paid order is \"captured\".
|
|
9240
|
+
* @param {Array<ListStoreOrdersV1FulfillmentStatusEnum>} [fulfillmentStatus] Fulfilment statuses to include.
|
|
9241
|
+
* @param {string} [email] Customer email, matched exactly.
|
|
9242
|
+
* @param {string} [displayId] The order number the merchant and customer see.
|
|
9243
|
+
* @param {string} [q] Free-text search over customer name, email, order number and line items.
|
|
9244
|
+
* @param {string} [createdAtFrom] Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC).
|
|
9245
|
+
* @param {string} [createdAtTo] Latest creation time to include, inclusive. A bare date covers that whole day.
|
|
9246
|
+
* @param {number} [page] Page number
|
|
9247
|
+
* @param {*} [options] Override http request option.
|
|
9248
|
+
* @throws {RequiredError}
|
|
9249
|
+
*/
|
|
9250
|
+
listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options) {
|
|
9251
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9252
|
+
var _a, _b;
|
|
9253
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options);
|
|
9254
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceOrdersApi.listStoreOrdersV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9255
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9256
|
+
});
|
|
9257
|
+
},
|
|
9258
|
+
/**
|
|
9259
|
+
* Retrieve one order in full: line items (each with the id the fulfil endpoint needs), addresses, the totals breakdown and fulfilments with tracking. Amounts are in the smallest currency unit.
|
|
9260
|
+
* @summary Retrieve an order
|
|
9261
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9262
|
+
* @param {string} orderId The ID of the order to retrieve.
|
|
9263
|
+
* @param {*} [options] Override http request option.
|
|
9264
|
+
* @throws {RequiredError}
|
|
9265
|
+
*/
|
|
9266
|
+
retrieveAnOrderV1(storeId, orderId, options) {
|
|
9267
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9268
|
+
var _a, _b;
|
|
9269
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.retrieveAnOrderV1(storeId, orderId, options);
|
|
9270
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceOrdersApi.retrieveAnOrderV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9271
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9272
|
+
});
|
|
9273
|
+
},
|
|
9274
|
+
};
|
|
9275
|
+
};
|
|
9276
|
+
exports.EcommerceOrdersApiFp = EcommerceOrdersApiFp;
|
|
9277
|
+
/**
|
|
9278
|
+
* EcommerceOrdersApi - factory interface
|
|
9279
|
+
* @export
|
|
9280
|
+
*/
|
|
9281
|
+
const EcommerceOrdersApiFactory = function (configuration, basePath, axios) {
|
|
9282
|
+
const localVarFp = (0, exports.EcommerceOrdersApiFp)(configuration);
|
|
9283
|
+
return {
|
|
9284
|
+
/**
|
|
9285
|
+
* Cancel the order and optionally email the customer. Returns the updated order summary.
|
|
9286
|
+
* @summary Cancel an order
|
|
9287
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9288
|
+
* @param {string} orderId The ID of the order to cancel.
|
|
9289
|
+
* @param {EcommerceV1OrderCancelRequest} ecommerceV1OrderCancelRequest
|
|
9290
|
+
* @param {*} [options] Override http request option.
|
|
9291
|
+
* @throws {RequiredError}
|
|
9292
|
+
*/
|
|
9293
|
+
cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options) {
|
|
9294
|
+
return localVarFp.cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options).then((request) => request(axios, basePath));
|
|
9295
|
+
},
|
|
9296
|
+
/**
|
|
9297
|
+
* Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil every remaining unfulfilled item. Returns the updated order summary.
|
|
9298
|
+
* @summary Fulfil an order
|
|
9299
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9300
|
+
* @param {string} orderId The ID of the order to fulfil.
|
|
9301
|
+
* @param {EcommerceV1OrderFulfillRequest} ecommerceV1OrderFulfillRequest
|
|
9302
|
+
* @param {*} [options] Override http request option.
|
|
9303
|
+
* @throws {RequiredError}
|
|
9304
|
+
*/
|
|
9305
|
+
fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options) {
|
|
9306
|
+
return localVarFp.fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options).then((request) => request(axios, basePath));
|
|
9307
|
+
},
|
|
9308
|
+
/**
|
|
9309
|
+
* List a store\'s orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments.
|
|
9310
|
+
* @summary List store orders
|
|
9311
|
+
* @param {string} storeId The ID of the store to list orders for.
|
|
9312
|
+
* @param {Array<ListStoreOrdersV1StatusEnum>} [status] Order statuses to include.
|
|
9313
|
+
* @param {Array<ListStoreOrdersV1PaymentStatusEnum>} [paymentStatus] Payment statuses to include. A paid order is \"captured\".
|
|
9314
|
+
* @param {Array<ListStoreOrdersV1FulfillmentStatusEnum>} [fulfillmentStatus] Fulfilment statuses to include.
|
|
9315
|
+
* @param {string} [email] Customer email, matched exactly.
|
|
9316
|
+
* @param {string} [displayId] The order number the merchant and customer see.
|
|
9317
|
+
* @param {string} [q] Free-text search over customer name, email, order number and line items.
|
|
9318
|
+
* @param {string} [createdAtFrom] Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC).
|
|
9319
|
+
* @param {string} [createdAtTo] Latest creation time to include, inclusive. A bare date covers that whole day.
|
|
9320
|
+
* @param {number} [page] Page number
|
|
9321
|
+
* @param {*} [options] Override http request option.
|
|
9322
|
+
* @throws {RequiredError}
|
|
9323
|
+
*/
|
|
9324
|
+
listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options) {
|
|
9325
|
+
return localVarFp.listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options).then((request) => request(axios, basePath));
|
|
9326
|
+
},
|
|
9327
|
+
/**
|
|
9328
|
+
* Retrieve one order in full: line items (each with the id the fulfil endpoint needs), addresses, the totals breakdown and fulfilments with tracking. Amounts are in the smallest currency unit.
|
|
9329
|
+
* @summary Retrieve an order
|
|
9330
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9331
|
+
* @param {string} orderId The ID of the order to retrieve.
|
|
9332
|
+
* @param {*} [options] Override http request option.
|
|
9333
|
+
* @throws {RequiredError}
|
|
9334
|
+
*/
|
|
9335
|
+
retrieveAnOrderV1(storeId, orderId, options) {
|
|
9336
|
+
return localVarFp.retrieveAnOrderV1(storeId, orderId, options).then((request) => request(axios, basePath));
|
|
9337
|
+
},
|
|
9338
|
+
};
|
|
9339
|
+
};
|
|
9340
|
+
exports.EcommerceOrdersApiFactory = EcommerceOrdersApiFactory;
|
|
9341
|
+
/**
|
|
9342
|
+
* EcommerceOrdersApi - object-oriented interface
|
|
9343
|
+
* @export
|
|
9344
|
+
* @class EcommerceOrdersApi
|
|
9345
|
+
* @extends {BaseAPI}
|
|
9346
|
+
*/
|
|
9347
|
+
class EcommerceOrdersApi extends base_1.BaseAPI {
|
|
9348
|
+
/**
|
|
9349
|
+
* Cancel the order and optionally email the customer. Returns the updated order summary.
|
|
9350
|
+
* @summary Cancel an order
|
|
9351
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9352
|
+
* @param {string} orderId The ID of the order to cancel.
|
|
9353
|
+
* @param {EcommerceV1OrderCancelRequest} ecommerceV1OrderCancelRequest
|
|
9354
|
+
* @param {*} [options] Override http request option.
|
|
9355
|
+
* @throws {RequiredError}
|
|
9356
|
+
* @memberof EcommerceOrdersApi
|
|
9357
|
+
*/
|
|
9358
|
+
cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options) {
|
|
9359
|
+
return (0, exports.EcommerceOrdersApiFp)(this.configuration).cancelAnOrderV1(storeId, orderId, ecommerceV1OrderCancelRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9360
|
+
}
|
|
9361
|
+
/**
|
|
9362
|
+
* Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil every remaining unfulfilled item. Returns the updated order summary.
|
|
9363
|
+
* @summary Fulfil an order
|
|
9364
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9365
|
+
* @param {string} orderId The ID of the order to fulfil.
|
|
9366
|
+
* @param {EcommerceV1OrderFulfillRequest} ecommerceV1OrderFulfillRequest
|
|
9367
|
+
* @param {*} [options] Override http request option.
|
|
9368
|
+
* @throws {RequiredError}
|
|
9369
|
+
* @memberof EcommerceOrdersApi
|
|
9370
|
+
*/
|
|
9371
|
+
fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options) {
|
|
9372
|
+
return (0, exports.EcommerceOrdersApiFp)(this.configuration).fulfilAnOrderV1(storeId, orderId, ecommerceV1OrderFulfillRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9373
|
+
}
|
|
9374
|
+
/**
|
|
9375
|
+
* List a store\'s orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments.
|
|
9376
|
+
* @summary List store orders
|
|
9377
|
+
* @param {string} storeId The ID of the store to list orders for.
|
|
9378
|
+
* @param {Array<ListStoreOrdersV1StatusEnum>} [status] Order statuses to include.
|
|
9379
|
+
* @param {Array<ListStoreOrdersV1PaymentStatusEnum>} [paymentStatus] Payment statuses to include. A paid order is \"captured\".
|
|
9380
|
+
* @param {Array<ListStoreOrdersV1FulfillmentStatusEnum>} [fulfillmentStatus] Fulfilment statuses to include.
|
|
9381
|
+
* @param {string} [email] Customer email, matched exactly.
|
|
9382
|
+
* @param {string} [displayId] The order number the merchant and customer see.
|
|
9383
|
+
* @param {string} [q] Free-text search over customer name, email, order number and line items.
|
|
9384
|
+
* @param {string} [createdAtFrom] Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC).
|
|
9385
|
+
* @param {string} [createdAtTo] Latest creation time to include, inclusive. A bare date covers that whole day.
|
|
9386
|
+
* @param {number} [page] Page number
|
|
9387
|
+
* @param {*} [options] Override http request option.
|
|
9388
|
+
* @throws {RequiredError}
|
|
9389
|
+
* @memberof EcommerceOrdersApi
|
|
9390
|
+
*/
|
|
9391
|
+
listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options) {
|
|
9392
|
+
return (0, exports.EcommerceOrdersApiFp)(this.configuration).listStoreOrdersV1(storeId, status, paymentStatus, fulfillmentStatus, email, displayId, q, createdAtFrom, createdAtTo, page, options).then((request) => request(this.axios, this.basePath));
|
|
9393
|
+
}
|
|
9394
|
+
/**
|
|
9395
|
+
* Retrieve one order in full: line items (each with the id the fulfil endpoint needs), addresses, the totals breakdown and fulfilments with tracking. Amounts are in the smallest currency unit.
|
|
9396
|
+
* @summary Retrieve an order
|
|
9397
|
+
* @param {string} storeId The ID of the store that owns the order.
|
|
9398
|
+
* @param {string} orderId The ID of the order to retrieve.
|
|
9399
|
+
* @param {*} [options] Override http request option.
|
|
9400
|
+
* @throws {RequiredError}
|
|
9401
|
+
* @memberof EcommerceOrdersApi
|
|
9402
|
+
*/
|
|
9403
|
+
retrieveAnOrderV1(storeId, orderId, options) {
|
|
9404
|
+
return (0, exports.EcommerceOrdersApiFp)(this.configuration).retrieveAnOrderV1(storeId, orderId, options).then((request) => request(this.axios, this.basePath));
|
|
9405
|
+
}
|
|
9406
|
+
}
|
|
9407
|
+
exports.EcommerceOrdersApi = EcommerceOrdersApi;
|
|
9408
|
+
/**
|
|
9409
|
+
* @export
|
|
9410
|
+
*/
|
|
9411
|
+
exports.ListStoreOrdersV1StatusEnum = {
|
|
9412
|
+
Pending: 'pending',
|
|
9413
|
+
Completed: 'completed',
|
|
9414
|
+
Archived: 'archived',
|
|
9415
|
+
Canceled: 'canceled',
|
|
9416
|
+
RequiresAction: 'requires_action'
|
|
9417
|
+
};
|
|
9418
|
+
/**
|
|
9419
|
+
* @export
|
|
9420
|
+
*/
|
|
9421
|
+
exports.ListStoreOrdersV1PaymentStatusEnum = {
|
|
9422
|
+
NotPaid: 'not_paid',
|
|
9423
|
+
Awaiting: 'awaiting',
|
|
9424
|
+
Captured: 'captured',
|
|
9425
|
+
PartiallyRefunded: 'partially_refunded',
|
|
9426
|
+
Refunded: 'refunded',
|
|
9427
|
+
Canceled: 'canceled',
|
|
9428
|
+
RequiresAction: 'requires_action',
|
|
9429
|
+
NotRequired: 'not_required'
|
|
9430
|
+
};
|
|
9431
|
+
/**
|
|
9432
|
+
* @export
|
|
9433
|
+
*/
|
|
9434
|
+
exports.ListStoreOrdersV1FulfillmentStatusEnum = {
|
|
9435
|
+
NotFulfilled: 'not_fulfilled',
|
|
9436
|
+
PartiallyFulfilled: 'partially_fulfilled',
|
|
9437
|
+
Fulfilled: 'fulfilled',
|
|
9438
|
+
PartiallyShipped: 'partially_shipped',
|
|
9439
|
+
Shipped: 'shipped',
|
|
9440
|
+
PartiallyReturned: 'partially_returned',
|
|
9441
|
+
Returned: 'returned',
|
|
9442
|
+
Canceled: 'canceled',
|
|
9443
|
+
RequiresAction: 'requires_action'
|
|
9444
|
+
};
|
|
9445
|
+
/**
|
|
9446
|
+
* EcommercePaymentsApi - axios parameter creator
|
|
9447
|
+
* @export
|
|
9448
|
+
*/
|
|
9449
|
+
const EcommercePaymentsApiAxiosParamCreator = function (configuration) {
|
|
9450
|
+
return {
|
|
9451
|
+
/**
|
|
9452
|
+
* Create an onboarding link for connecting a payment gateway to the store. Returns the gateway onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
9453
|
+
* @summary Create a payment provider connect link
|
|
9454
|
+
* @param {string} storeId The ID of the store to connect the payment provider to.
|
|
9455
|
+
* @param {string} providerId The ID of the payment gateway to connect, e.g. stripe.
|
|
9456
|
+
* @param {*} [options] Override http request option.
|
|
9457
|
+
* @throws {RequiredError}
|
|
9458
|
+
*/
|
|
9459
|
+
createAPaymentProviderConnectLinkV1: (storeId_1, providerId_1, ...args_1) => __awaiter(this, [storeId_1, providerId_1, ...args_1], void 0, function* (storeId, providerId, options = {}) {
|
|
9460
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9461
|
+
(0, common_1.assertParamExists)('createAPaymentProviderConnectLinkV1', 'storeId', storeId);
|
|
9462
|
+
// verify required parameter 'providerId' is not null or undefined
|
|
9463
|
+
(0, common_1.assertParamExists)('createAPaymentProviderConnectLinkV1', 'providerId', providerId);
|
|
9464
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/payment-providers/{provider_id}/connect-link`
|
|
9465
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9466
|
+
.replace(`{${"provider_id"}}`, encodeURIComponent(String(providerId)));
|
|
9467
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9468
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9469
|
+
let baseOptions;
|
|
9470
|
+
if (configuration) {
|
|
9471
|
+
baseOptions = configuration.baseOptions;
|
|
9472
|
+
}
|
|
9473
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
9474
|
+
const localVarHeaderParameter = {};
|
|
9475
|
+
const localVarQueryParameter = {};
|
|
9476
|
+
// authentication apiToken required
|
|
9477
|
+
// http bearer authentication required
|
|
9478
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9479
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9480
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9481
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9482
|
+
return {
|
|
9483
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9484
|
+
options: localVarRequestOptions,
|
|
9485
|
+
};
|
|
9486
|
+
}),
|
|
9487
|
+
/**
|
|
9488
|
+
* Enable a manual payment method so the store can accept orders without an online payment provider.
|
|
9489
|
+
* @summary Enable manual payment method
|
|
9490
|
+
* @param {string} storeId The ID of the store to enable manual payment for.
|
|
9491
|
+
* @param {EcommerceV1PaymentEnableManualPaymentRequest} ecommerceV1PaymentEnableManualPaymentRequest
|
|
9492
|
+
* @param {*} [options] Override http request option.
|
|
9493
|
+
* @throws {RequiredError}
|
|
9494
|
+
*/
|
|
9495
|
+
enableManualPaymentMethodV1: (storeId_1, ecommerceV1PaymentEnableManualPaymentRequest_1, ...args_1) => __awaiter(this, [storeId_1, ecommerceV1PaymentEnableManualPaymentRequest_1, ...args_1], void 0, function* (storeId, ecommerceV1PaymentEnableManualPaymentRequest, options = {}) {
|
|
9496
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9497
|
+
(0, common_1.assertParamExists)('enableManualPaymentMethodV1', 'storeId', storeId);
|
|
9498
|
+
// verify required parameter 'ecommerceV1PaymentEnableManualPaymentRequest' is not null or undefined
|
|
9499
|
+
(0, common_1.assertParamExists)('enableManualPaymentMethodV1', 'ecommerceV1PaymentEnableManualPaymentRequest', ecommerceV1PaymentEnableManualPaymentRequest);
|
|
9500
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/payment-methods/manual`
|
|
9501
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
9502
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9503
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9504
|
+
let baseOptions;
|
|
9505
|
+
if (configuration) {
|
|
9506
|
+
baseOptions = configuration.baseOptions;
|
|
9507
|
+
}
|
|
9508
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
9509
|
+
const localVarHeaderParameter = {};
|
|
9510
|
+
const localVarQueryParameter = {};
|
|
9511
|
+
// authentication apiToken required
|
|
9512
|
+
// http bearer authentication required
|
|
9513
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9514
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9515
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9516
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9517
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9518
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1PaymentEnableManualPaymentRequest, localVarRequestOptions, configuration);
|
|
9519
|
+
return {
|
|
9520
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9521
|
+
options: localVarRequestOptions,
|
|
9522
|
+
};
|
|
9523
|
+
}),
|
|
9524
|
+
/**
|
|
9525
|
+
* List a store\'s payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration.
|
|
9526
|
+
* @summary List store payment providers
|
|
9527
|
+
* @param {string} storeId The ID of the store to list payment providers for.
|
|
9528
|
+
* @param {boolean} [includeCurrencyUnsupported] Include gateways that do not support the store currency in the available list.
|
|
9529
|
+
* @param {*} [options] Override http request option.
|
|
9530
|
+
* @throws {RequiredError}
|
|
9531
|
+
*/
|
|
9532
|
+
listStorePaymentProvidersV1: (storeId_1, includeCurrencyUnsupported_1, ...args_1) => __awaiter(this, [storeId_1, includeCurrencyUnsupported_1, ...args_1], void 0, function* (storeId, includeCurrencyUnsupported, options = {}) {
|
|
9533
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9534
|
+
(0, common_1.assertParamExists)('listStorePaymentProvidersV1', 'storeId', storeId);
|
|
9535
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/payment-providers`
|
|
9536
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
9537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9538
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9539
|
+
let baseOptions;
|
|
9540
|
+
if (configuration) {
|
|
9541
|
+
baseOptions = configuration.baseOptions;
|
|
9542
|
+
}
|
|
9543
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
9544
|
+
const localVarHeaderParameter = {};
|
|
9545
|
+
const localVarQueryParameter = {};
|
|
9546
|
+
// authentication apiToken required
|
|
9547
|
+
// http bearer authentication required
|
|
9548
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9549
|
+
if (includeCurrencyUnsupported !== undefined) {
|
|
9550
|
+
localVarQueryParameter['include_currency_unsupported'] = includeCurrencyUnsupported;
|
|
9551
|
+
}
|
|
9552
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9553
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9554
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9555
|
+
return {
|
|
9556
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9557
|
+
options: localVarRequestOptions,
|
|
9558
|
+
};
|
|
9559
|
+
}),
|
|
9560
|
+
};
|
|
9561
|
+
};
|
|
9562
|
+
exports.EcommercePaymentsApiAxiosParamCreator = EcommercePaymentsApiAxiosParamCreator;
|
|
9563
|
+
/**
|
|
9564
|
+
* EcommercePaymentsApi - functional programming interface
|
|
9565
|
+
* @export
|
|
9566
|
+
*/
|
|
9567
|
+
const EcommercePaymentsApiFp = function (configuration) {
|
|
9568
|
+
const localVarAxiosParamCreator = (0, exports.EcommercePaymentsApiAxiosParamCreator)(configuration);
|
|
9569
|
+
return {
|
|
9570
|
+
/**
|
|
9571
|
+
* Create an onboarding link for connecting a payment gateway to the store. Returns the gateway onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
9572
|
+
* @summary Create a payment provider connect link
|
|
9573
|
+
* @param {string} storeId The ID of the store to connect the payment provider to.
|
|
9574
|
+
* @param {string} providerId The ID of the payment gateway to connect, e.g. stripe.
|
|
9575
|
+
* @param {*} [options] Override http request option.
|
|
9576
|
+
* @throws {RequiredError}
|
|
9577
|
+
*/
|
|
9578
|
+
createAPaymentProviderConnectLinkV1(storeId, providerId, options) {
|
|
9579
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9580
|
+
var _a, _b;
|
|
9581
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createAPaymentProviderConnectLinkV1(storeId, providerId, options);
|
|
9582
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommercePaymentsApi.createAPaymentProviderConnectLinkV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9583
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9584
|
+
});
|
|
9585
|
+
},
|
|
9586
|
+
/**
|
|
9587
|
+
* Enable a manual payment method so the store can accept orders without an online payment provider.
|
|
9588
|
+
* @summary Enable manual payment method
|
|
9589
|
+
* @param {string} storeId The ID of the store to enable manual payment for.
|
|
9590
|
+
* @param {EcommerceV1PaymentEnableManualPaymentRequest} ecommerceV1PaymentEnableManualPaymentRequest
|
|
9591
|
+
* @param {*} [options] Override http request option.
|
|
9592
|
+
* @throws {RequiredError}
|
|
9593
|
+
*/
|
|
9594
|
+
enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options) {
|
|
9595
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9596
|
+
var _a, _b;
|
|
9597
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options);
|
|
9598
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommercePaymentsApi.enableManualPaymentMethodV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9599
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9600
|
+
});
|
|
9601
|
+
},
|
|
9602
|
+
/**
|
|
9603
|
+
* List a store\'s payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration.
|
|
9604
|
+
* @summary List store payment providers
|
|
9605
|
+
* @param {string} storeId The ID of the store to list payment providers for.
|
|
9606
|
+
* @param {boolean} [includeCurrencyUnsupported] Include gateways that do not support the store currency in the available list.
|
|
9607
|
+
* @param {*} [options] Override http request option.
|
|
9608
|
+
* @throws {RequiredError}
|
|
9609
|
+
*/
|
|
9610
|
+
listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options) {
|
|
9611
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9612
|
+
var _a, _b;
|
|
9613
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options);
|
|
9614
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommercePaymentsApi.listStorePaymentProvidersV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9615
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9616
|
+
});
|
|
9617
|
+
},
|
|
9618
|
+
};
|
|
9619
|
+
};
|
|
9620
|
+
exports.EcommercePaymentsApiFp = EcommercePaymentsApiFp;
|
|
9621
|
+
/**
|
|
9622
|
+
* EcommercePaymentsApi - factory interface
|
|
9623
|
+
* @export
|
|
9624
|
+
*/
|
|
9625
|
+
const EcommercePaymentsApiFactory = function (configuration, basePath, axios) {
|
|
9626
|
+
const localVarFp = (0, exports.EcommercePaymentsApiFp)(configuration);
|
|
9627
|
+
return {
|
|
9628
|
+
/**
|
|
9629
|
+
* Create an onboarding link for connecting a payment gateway to the store. Returns the gateway onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
9630
|
+
* @summary Create a payment provider connect link
|
|
9631
|
+
* @param {string} storeId The ID of the store to connect the payment provider to.
|
|
9632
|
+
* @param {string} providerId The ID of the payment gateway to connect, e.g. stripe.
|
|
9633
|
+
* @param {*} [options] Override http request option.
|
|
9634
|
+
* @throws {RequiredError}
|
|
9635
|
+
*/
|
|
9636
|
+
createAPaymentProviderConnectLinkV1(storeId, providerId, options) {
|
|
9637
|
+
return localVarFp.createAPaymentProviderConnectLinkV1(storeId, providerId, options).then((request) => request(axios, basePath));
|
|
9638
|
+
},
|
|
9639
|
+
/**
|
|
9640
|
+
* Enable a manual payment method so the store can accept orders without an online payment provider.
|
|
9641
|
+
* @summary Enable manual payment method
|
|
9642
|
+
* @param {string} storeId The ID of the store to enable manual payment for.
|
|
9643
|
+
* @param {EcommerceV1PaymentEnableManualPaymentRequest} ecommerceV1PaymentEnableManualPaymentRequest
|
|
9644
|
+
* @param {*} [options] Override http request option.
|
|
9645
|
+
* @throws {RequiredError}
|
|
9646
|
+
*/
|
|
9647
|
+
enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options) {
|
|
9648
|
+
return localVarFp.enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options).then((request) => request(axios, basePath));
|
|
9649
|
+
},
|
|
9650
|
+
/**
|
|
9651
|
+
* List a store\'s payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration.
|
|
9652
|
+
* @summary List store payment providers
|
|
9653
|
+
* @param {string} storeId The ID of the store to list payment providers for.
|
|
9654
|
+
* @param {boolean} [includeCurrencyUnsupported] Include gateways that do not support the store currency in the available list.
|
|
9655
|
+
* @param {*} [options] Override http request option.
|
|
9656
|
+
* @throws {RequiredError}
|
|
9657
|
+
*/
|
|
9658
|
+
listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options) {
|
|
9659
|
+
return localVarFp.listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options).then((request) => request(axios, basePath));
|
|
9660
|
+
},
|
|
9661
|
+
};
|
|
9662
|
+
};
|
|
9663
|
+
exports.EcommercePaymentsApiFactory = EcommercePaymentsApiFactory;
|
|
9664
|
+
/**
|
|
9665
|
+
* EcommercePaymentsApi - object-oriented interface
|
|
9666
|
+
* @export
|
|
9667
|
+
* @class EcommercePaymentsApi
|
|
9668
|
+
* @extends {BaseAPI}
|
|
9669
|
+
*/
|
|
9670
|
+
class EcommercePaymentsApi extends base_1.BaseAPI {
|
|
9671
|
+
/**
|
|
9672
|
+
* Create an onboarding link for connecting a payment gateway to the store. Returns the gateway onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
9673
|
+
* @summary Create a payment provider connect link
|
|
9674
|
+
* @param {string} storeId The ID of the store to connect the payment provider to.
|
|
9675
|
+
* @param {string} providerId The ID of the payment gateway to connect, e.g. stripe.
|
|
9676
|
+
* @param {*} [options] Override http request option.
|
|
9677
|
+
* @throws {RequiredError}
|
|
9678
|
+
* @memberof EcommercePaymentsApi
|
|
9679
|
+
*/
|
|
9680
|
+
createAPaymentProviderConnectLinkV1(storeId, providerId, options) {
|
|
9681
|
+
return (0, exports.EcommercePaymentsApiFp)(this.configuration).createAPaymentProviderConnectLinkV1(storeId, providerId, options).then((request) => request(this.axios, this.basePath));
|
|
9682
|
+
}
|
|
9683
|
+
/**
|
|
9684
|
+
* Enable a manual payment method so the store can accept orders without an online payment provider.
|
|
9685
|
+
* @summary Enable manual payment method
|
|
9686
|
+
* @param {string} storeId The ID of the store to enable manual payment for.
|
|
9687
|
+
* @param {EcommerceV1PaymentEnableManualPaymentRequest} ecommerceV1PaymentEnableManualPaymentRequest
|
|
9688
|
+
* @param {*} [options] Override http request option.
|
|
9689
|
+
* @throws {RequiredError}
|
|
9690
|
+
* @memberof EcommercePaymentsApi
|
|
9691
|
+
*/
|
|
9692
|
+
enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options) {
|
|
9693
|
+
return (0, exports.EcommercePaymentsApiFp)(this.configuration).enableManualPaymentMethodV1(storeId, ecommerceV1PaymentEnableManualPaymentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9694
|
+
}
|
|
9695
|
+
/**
|
|
9696
|
+
* List a store\'s payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration.
|
|
9697
|
+
* @summary List store payment providers
|
|
9698
|
+
* @param {string} storeId The ID of the store to list payment providers for.
|
|
9699
|
+
* @param {boolean} [includeCurrencyUnsupported] Include gateways that do not support the store currency in the available list.
|
|
9700
|
+
* @param {*} [options] Override http request option.
|
|
9701
|
+
* @throws {RequiredError}
|
|
9702
|
+
* @memberof EcommercePaymentsApi
|
|
9703
|
+
*/
|
|
9704
|
+
listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options) {
|
|
9705
|
+
return (0, exports.EcommercePaymentsApiFp)(this.configuration).listStorePaymentProvidersV1(storeId, includeCurrencyUnsupported, options).then((request) => request(this.axios, this.basePath));
|
|
9706
|
+
}
|
|
9707
|
+
}
|
|
9708
|
+
exports.EcommercePaymentsApi = EcommercePaymentsApi;
|
|
9709
|
+
/**
|
|
9710
|
+
* EcommerceProductVariantsApi - axios parameter creator
|
|
9711
|
+
* @export
|
|
9712
|
+
*/
|
|
9713
|
+
const EcommerceProductVariantsApiAxiosParamCreator = function (configuration) {
|
|
9714
|
+
return {
|
|
9715
|
+
/**
|
|
9716
|
+
* Add a variant to a product along one or more option dimensions (e.g. Size, Color). Options missing from the product are created automatically; provide a value for every option the product already has. Prices are integers in the smallest currency unit and default to the store currency. Returns the created variant.
|
|
9717
|
+
* @summary Create a product variant
|
|
9718
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9719
|
+
* @param {string} productId The ID of the product to add the variant to.
|
|
9720
|
+
* @param {EcommerceV1VariantCreateVariantRequest} ecommerceV1VariantCreateVariantRequest
|
|
9721
|
+
* @param {*} [options] Override http request option.
|
|
9722
|
+
* @throws {RequiredError}
|
|
9723
|
+
*/
|
|
9724
|
+
createAProductVariantV1: (storeId_1, productId_1, ecommerceV1VariantCreateVariantRequest_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, ecommerceV1VariantCreateVariantRequest_1, ...args_1], void 0, function* (storeId, productId, ecommerceV1VariantCreateVariantRequest, options = {}) {
|
|
9725
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9726
|
+
(0, common_1.assertParamExists)('createAProductVariantV1', 'storeId', storeId);
|
|
9727
|
+
// verify required parameter 'productId' is not null or undefined
|
|
9728
|
+
(0, common_1.assertParamExists)('createAProductVariantV1', 'productId', productId);
|
|
9729
|
+
// verify required parameter 'ecommerceV1VariantCreateVariantRequest' is not null or undefined
|
|
9730
|
+
(0, common_1.assertParamExists)('createAProductVariantV1', 'ecommerceV1VariantCreateVariantRequest', ecommerceV1VariantCreateVariantRequest);
|
|
9731
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants`
|
|
9732
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9733
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)));
|
|
9734
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9735
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9736
|
+
let baseOptions;
|
|
9737
|
+
if (configuration) {
|
|
9738
|
+
baseOptions = configuration.baseOptions;
|
|
9739
|
+
}
|
|
9740
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
9741
|
+
const localVarHeaderParameter = {};
|
|
9742
|
+
const localVarQueryParameter = {};
|
|
9743
|
+
// authentication apiToken required
|
|
9744
|
+
// http bearer authentication required
|
|
9745
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9746
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9747
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9748
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9749
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9750
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1VariantCreateVariantRequest, localVarRequestOptions, configuration);
|
|
9751
|
+
return {
|
|
9752
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9753
|
+
options: localVarRequestOptions,
|
|
9754
|
+
};
|
|
9755
|
+
}),
|
|
9756
|
+
/**
|
|
9757
|
+
* Delete a single variant from the product.
|
|
9758
|
+
* @summary Delete a product variant
|
|
9759
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9760
|
+
* @param {string} productId The ID of the product that owns the variant.
|
|
9761
|
+
* @param {string} variantId The ID of the variant to delete.
|
|
9762
|
+
* @param {*} [options] Override http request option.
|
|
9763
|
+
* @throws {RequiredError}
|
|
9764
|
+
*/
|
|
9765
|
+
deleteAProductVariantV1: (storeId_1, productId_1, variantId_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, variantId_1, ...args_1], void 0, function* (storeId, productId, variantId, options = {}) {
|
|
9766
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9767
|
+
(0, common_1.assertParamExists)('deleteAProductVariantV1', 'storeId', storeId);
|
|
9768
|
+
// verify required parameter 'productId' is not null or undefined
|
|
9769
|
+
(0, common_1.assertParamExists)('deleteAProductVariantV1', 'productId', productId);
|
|
9770
|
+
// verify required parameter 'variantId' is not null or undefined
|
|
9771
|
+
(0, common_1.assertParamExists)('deleteAProductVariantV1', 'variantId', variantId);
|
|
9772
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}`
|
|
9773
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9774
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)))
|
|
9775
|
+
.replace(`{${"variant_id"}}`, encodeURIComponent(String(variantId)));
|
|
9776
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9777
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9778
|
+
let baseOptions;
|
|
9779
|
+
if (configuration) {
|
|
9780
|
+
baseOptions = configuration.baseOptions;
|
|
9781
|
+
}
|
|
9782
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
9783
|
+
const localVarHeaderParameter = {};
|
|
9784
|
+
const localVarQueryParameter = {};
|
|
9785
|
+
// authentication apiToken required
|
|
9786
|
+
// http bearer authentication required
|
|
9787
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9788
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9789
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9790
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9791
|
+
return {
|
|
9792
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9793
|
+
options: localVarRequestOptions,
|
|
9794
|
+
};
|
|
9795
|
+
}),
|
|
9796
|
+
/**
|
|
9797
|
+
* List a product\'s variants, ordered by rank, with their options, prices and inventory. Prices are integers in the smallest currency unit and live on variants.
|
|
9798
|
+
* @summary List product variants
|
|
9799
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9800
|
+
* @param {string} productId The ID of the product to list variants for.
|
|
9801
|
+
* @param {number} [page] Page number
|
|
9802
|
+
* @param {*} [options] Override http request option.
|
|
9803
|
+
* @throws {RequiredError}
|
|
9804
|
+
*/
|
|
9805
|
+
listProductVariantsV1: (storeId_1, productId_1, page_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, page_1, ...args_1], void 0, function* (storeId, productId, page, options = {}) {
|
|
9806
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9807
|
+
(0, common_1.assertParamExists)('listProductVariantsV1', 'storeId', storeId);
|
|
9808
|
+
// verify required parameter 'productId' is not null or undefined
|
|
9809
|
+
(0, common_1.assertParamExists)('listProductVariantsV1', 'productId', productId);
|
|
9810
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants`
|
|
9811
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9812
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)));
|
|
9813
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9814
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9815
|
+
let baseOptions;
|
|
9816
|
+
if (configuration) {
|
|
9817
|
+
baseOptions = configuration.baseOptions;
|
|
9818
|
+
}
|
|
9819
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
9820
|
+
const localVarHeaderParameter = {};
|
|
9821
|
+
const localVarQueryParameter = {};
|
|
9822
|
+
// authentication apiToken required
|
|
9823
|
+
// http bearer authentication required
|
|
9824
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9825
|
+
if (page !== undefined) {
|
|
9826
|
+
localVarQueryParameter['page'] = page;
|
|
9827
|
+
}
|
|
9828
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9829
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9830
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9831
|
+
return {
|
|
9832
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9833
|
+
options: localVarRequestOptions,
|
|
9834
|
+
};
|
|
9835
|
+
}),
|
|
9836
|
+
/**
|
|
9837
|
+
* Update up to 100 existing variants in place by id — title, inventory, stock tracking and prices. Variants omitted from the request are left untouched. Prices replace the variant\'s existing prices in full. Returns the updated variants.
|
|
9838
|
+
* @summary Update product variants in batch
|
|
9839
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9840
|
+
* @param {string} productId The ID of the product whose variants are being updated.
|
|
9841
|
+
* @param {EcommerceV1VariantBatchUpdateVariantsRequest} ecommerceV1VariantBatchUpdateVariantsRequest
|
|
9842
|
+
* @param {*} [options] Override http request option.
|
|
9843
|
+
* @throws {RequiredError}
|
|
9844
|
+
*/
|
|
9845
|
+
updateProductVariantsInBatchV1: (storeId_1, productId_1, ecommerceV1VariantBatchUpdateVariantsRequest_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, ecommerceV1VariantBatchUpdateVariantsRequest_1, ...args_1], void 0, function* (storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options = {}) {
|
|
9846
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
9847
|
+
(0, common_1.assertParamExists)('updateProductVariantsInBatchV1', 'storeId', storeId);
|
|
9848
|
+
// verify required parameter 'productId' is not null or undefined
|
|
9849
|
+
(0, common_1.assertParamExists)('updateProductVariantsInBatchV1', 'productId', productId);
|
|
9850
|
+
// verify required parameter 'ecommerceV1VariantBatchUpdateVariantsRequest' is not null or undefined
|
|
9851
|
+
(0, common_1.assertParamExists)('updateProductVariantsInBatchV1', 'ecommerceV1VariantBatchUpdateVariantsRequest', ecommerceV1VariantBatchUpdateVariantsRequest);
|
|
9852
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/batch`
|
|
9853
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
9854
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)));
|
|
9855
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9856
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
9857
|
+
let baseOptions;
|
|
9858
|
+
if (configuration) {
|
|
9859
|
+
baseOptions = configuration.baseOptions;
|
|
9860
|
+
}
|
|
9861
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
9862
|
+
const localVarHeaderParameter = {};
|
|
9863
|
+
const localVarQueryParameter = {};
|
|
9864
|
+
// authentication apiToken required
|
|
9865
|
+
// http bearer authentication required
|
|
9866
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
9867
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
9868
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
9869
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9870
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
9871
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1VariantBatchUpdateVariantsRequest, localVarRequestOptions, configuration);
|
|
9872
|
+
return {
|
|
9873
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
9874
|
+
options: localVarRequestOptions,
|
|
9875
|
+
};
|
|
9876
|
+
}),
|
|
9877
|
+
};
|
|
9878
|
+
};
|
|
9879
|
+
exports.EcommerceProductVariantsApiAxiosParamCreator = EcommerceProductVariantsApiAxiosParamCreator;
|
|
9880
|
+
/**
|
|
9881
|
+
* EcommerceProductVariantsApi - functional programming interface
|
|
8722
9882
|
* @export
|
|
8723
9883
|
*/
|
|
8724
|
-
const
|
|
8725
|
-
const
|
|
9884
|
+
const EcommerceProductVariantsApiFp = function (configuration) {
|
|
9885
|
+
const localVarAxiosParamCreator = (0, exports.EcommerceProductVariantsApiAxiosParamCreator)(configuration);
|
|
8726
9886
|
return {
|
|
8727
9887
|
/**
|
|
8728
|
-
*
|
|
8729
|
-
* @summary
|
|
8730
|
-
* @param {string} storeId The ID of the store
|
|
8731
|
-
* @param {
|
|
9888
|
+
* Add a variant to a product along one or more option dimensions (e.g. Size, Color). Options missing from the product are created automatically; provide a value for every option the product already has. Prices are integers in the smallest currency unit and default to the store currency. Returns the created variant.
|
|
9889
|
+
* @summary Create a product variant
|
|
9890
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9891
|
+
* @param {string} productId The ID of the product to add the variant to.
|
|
9892
|
+
* @param {EcommerceV1VariantCreateVariantRequest} ecommerceV1VariantCreateVariantRequest
|
|
8732
9893
|
* @param {*} [options] Override http request option.
|
|
8733
9894
|
* @throws {RequiredError}
|
|
8734
9895
|
*/
|
|
8735
|
-
|
|
8736
|
-
return
|
|
9896
|
+
createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options) {
|
|
9897
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9898
|
+
var _a, _b;
|
|
9899
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options);
|
|
9900
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductVariantsApi.createAProductVariantV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9901
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9902
|
+
});
|
|
9903
|
+
},
|
|
9904
|
+
/**
|
|
9905
|
+
* Delete a single variant from the product.
|
|
9906
|
+
* @summary Delete a product variant
|
|
9907
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9908
|
+
* @param {string} productId The ID of the product that owns the variant.
|
|
9909
|
+
* @param {string} variantId The ID of the variant to delete.
|
|
9910
|
+
* @param {*} [options] Override http request option.
|
|
9911
|
+
* @throws {RequiredError}
|
|
9912
|
+
*/
|
|
9913
|
+
deleteAProductVariantV1(storeId, productId, variantId, options) {
|
|
9914
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9915
|
+
var _a, _b;
|
|
9916
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAProductVariantV1(storeId, productId, variantId, options);
|
|
9917
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductVariantsApi.deleteAProductVariantV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9918
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9919
|
+
});
|
|
9920
|
+
},
|
|
9921
|
+
/**
|
|
9922
|
+
* List a product\'s variants, ordered by rank, with their options, prices and inventory. Prices are integers in the smallest currency unit and live on variants.
|
|
9923
|
+
* @summary List product variants
|
|
9924
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9925
|
+
* @param {string} productId The ID of the product to list variants for.
|
|
9926
|
+
* @param {number} [page] Page number
|
|
9927
|
+
* @param {*} [options] Override http request option.
|
|
9928
|
+
* @throws {RequiredError}
|
|
9929
|
+
*/
|
|
9930
|
+
listProductVariantsV1(storeId, productId, page, options) {
|
|
9931
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9932
|
+
var _a, _b;
|
|
9933
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductVariantsV1(storeId, productId, page, options);
|
|
9934
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductVariantsApi.listProductVariantsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9935
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9936
|
+
});
|
|
9937
|
+
},
|
|
9938
|
+
/**
|
|
9939
|
+
* Update up to 100 existing variants in place by id — title, inventory, stock tracking and prices. Variants omitted from the request are left untouched. Prices replace the variant\'s existing prices in full. Returns the updated variants.
|
|
9940
|
+
* @summary Update product variants in batch
|
|
9941
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9942
|
+
* @param {string} productId The ID of the product whose variants are being updated.
|
|
9943
|
+
* @param {EcommerceV1VariantBatchUpdateVariantsRequest} ecommerceV1VariantBatchUpdateVariantsRequest
|
|
9944
|
+
* @param {*} [options] Override http request option.
|
|
9945
|
+
* @throws {RequiredError}
|
|
9946
|
+
*/
|
|
9947
|
+
updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options) {
|
|
9948
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
9949
|
+
var _a, _b;
|
|
9950
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options);
|
|
9951
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductVariantsApi.updateProductVariantsInBatchV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9952
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9953
|
+
});
|
|
8737
9954
|
},
|
|
8738
9955
|
};
|
|
8739
9956
|
};
|
|
8740
|
-
exports.
|
|
9957
|
+
exports.EcommerceProductVariantsApiFp = EcommerceProductVariantsApiFp;
|
|
8741
9958
|
/**
|
|
8742
|
-
*
|
|
9959
|
+
* EcommerceProductVariantsApi - factory interface
|
|
8743
9960
|
* @export
|
|
8744
|
-
|
|
9961
|
+
*/
|
|
9962
|
+
const EcommerceProductVariantsApiFactory = function (configuration, basePath, axios) {
|
|
9963
|
+
const localVarFp = (0, exports.EcommerceProductVariantsApiFp)(configuration);
|
|
9964
|
+
return {
|
|
9965
|
+
/**
|
|
9966
|
+
* Add a variant to a product along one or more option dimensions (e.g. Size, Color). Options missing from the product are created automatically; provide a value for every option the product already has. Prices are integers in the smallest currency unit and default to the store currency. Returns the created variant.
|
|
9967
|
+
* @summary Create a product variant
|
|
9968
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9969
|
+
* @param {string} productId The ID of the product to add the variant to.
|
|
9970
|
+
* @param {EcommerceV1VariantCreateVariantRequest} ecommerceV1VariantCreateVariantRequest
|
|
9971
|
+
* @param {*} [options] Override http request option.
|
|
9972
|
+
* @throws {RequiredError}
|
|
9973
|
+
*/
|
|
9974
|
+
createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options) {
|
|
9975
|
+
return localVarFp.createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options).then((request) => request(axios, basePath));
|
|
9976
|
+
},
|
|
9977
|
+
/**
|
|
9978
|
+
* Delete a single variant from the product.
|
|
9979
|
+
* @summary Delete a product variant
|
|
9980
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9981
|
+
* @param {string} productId The ID of the product that owns the variant.
|
|
9982
|
+
* @param {string} variantId The ID of the variant to delete.
|
|
9983
|
+
* @param {*} [options] Override http request option.
|
|
9984
|
+
* @throws {RequiredError}
|
|
9985
|
+
*/
|
|
9986
|
+
deleteAProductVariantV1(storeId, productId, variantId, options) {
|
|
9987
|
+
return localVarFp.deleteAProductVariantV1(storeId, productId, variantId, options).then((request) => request(axios, basePath));
|
|
9988
|
+
},
|
|
9989
|
+
/**
|
|
9990
|
+
* List a product\'s variants, ordered by rank, with their options, prices and inventory. Prices are integers in the smallest currency unit and live on variants.
|
|
9991
|
+
* @summary List product variants
|
|
9992
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
9993
|
+
* @param {string} productId The ID of the product to list variants for.
|
|
9994
|
+
* @param {number} [page] Page number
|
|
9995
|
+
* @param {*} [options] Override http request option.
|
|
9996
|
+
* @throws {RequiredError}
|
|
9997
|
+
*/
|
|
9998
|
+
listProductVariantsV1(storeId, productId, page, options) {
|
|
9999
|
+
return localVarFp.listProductVariantsV1(storeId, productId, page, options).then((request) => request(axios, basePath));
|
|
10000
|
+
},
|
|
10001
|
+
/**
|
|
10002
|
+
* Update up to 100 existing variants in place by id — title, inventory, stock tracking and prices. Variants omitted from the request are left untouched. Prices replace the variant\'s existing prices in full. Returns the updated variants.
|
|
10003
|
+
* @summary Update product variants in batch
|
|
10004
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10005
|
+
* @param {string} productId The ID of the product whose variants are being updated.
|
|
10006
|
+
* @param {EcommerceV1VariantBatchUpdateVariantsRequest} ecommerceV1VariantBatchUpdateVariantsRequest
|
|
10007
|
+
* @param {*} [options] Override http request option.
|
|
10008
|
+
* @throws {RequiredError}
|
|
10009
|
+
*/
|
|
10010
|
+
updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options) {
|
|
10011
|
+
return localVarFp.updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options).then((request) => request(axios, basePath));
|
|
10012
|
+
},
|
|
10013
|
+
};
|
|
10014
|
+
};
|
|
10015
|
+
exports.EcommerceProductVariantsApiFactory = EcommerceProductVariantsApiFactory;
|
|
10016
|
+
/**
|
|
10017
|
+
* EcommerceProductVariantsApi - object-oriented interface
|
|
10018
|
+
* @export
|
|
10019
|
+
* @class EcommerceProductVariantsApi
|
|
8745
10020
|
* @extends {BaseAPI}
|
|
8746
10021
|
*/
|
|
8747
|
-
class
|
|
10022
|
+
class EcommerceProductVariantsApi extends base_1.BaseAPI {
|
|
8748
10023
|
/**
|
|
8749
|
-
*
|
|
8750
|
-
* @summary
|
|
8751
|
-
* @param {string} storeId The ID of the store
|
|
8752
|
-
* @param {
|
|
10024
|
+
* Add a variant to a product along one or more option dimensions (e.g. Size, Color). Options missing from the product are created automatically; provide a value for every option the product already has. Prices are integers in the smallest currency unit and default to the store currency. Returns the created variant.
|
|
10025
|
+
* @summary Create a product variant
|
|
10026
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10027
|
+
* @param {string} productId The ID of the product to add the variant to.
|
|
10028
|
+
* @param {EcommerceV1VariantCreateVariantRequest} ecommerceV1VariantCreateVariantRequest
|
|
8753
10029
|
* @param {*} [options] Override http request option.
|
|
8754
10030
|
* @throws {RequiredError}
|
|
8755
|
-
* @memberof
|
|
10031
|
+
* @memberof EcommerceProductVariantsApi
|
|
8756
10032
|
*/
|
|
8757
|
-
|
|
8758
|
-
return (0, exports.
|
|
10033
|
+
createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options) {
|
|
10034
|
+
return (0, exports.EcommerceProductVariantsApiFp)(this.configuration).createAProductVariantV1(storeId, productId, ecommerceV1VariantCreateVariantRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10035
|
+
}
|
|
10036
|
+
/**
|
|
10037
|
+
* Delete a single variant from the product.
|
|
10038
|
+
* @summary Delete a product variant
|
|
10039
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10040
|
+
* @param {string} productId The ID of the product that owns the variant.
|
|
10041
|
+
* @param {string} variantId The ID of the variant to delete.
|
|
10042
|
+
* @param {*} [options] Override http request option.
|
|
10043
|
+
* @throws {RequiredError}
|
|
10044
|
+
* @memberof EcommerceProductVariantsApi
|
|
10045
|
+
*/
|
|
10046
|
+
deleteAProductVariantV1(storeId, productId, variantId, options) {
|
|
10047
|
+
return (0, exports.EcommerceProductVariantsApiFp)(this.configuration).deleteAProductVariantV1(storeId, productId, variantId, options).then((request) => request(this.axios, this.basePath));
|
|
10048
|
+
}
|
|
10049
|
+
/**
|
|
10050
|
+
* List a product\'s variants, ordered by rank, with their options, prices and inventory. Prices are integers in the smallest currency unit and live on variants.
|
|
10051
|
+
* @summary List product variants
|
|
10052
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10053
|
+
* @param {string} productId The ID of the product to list variants for.
|
|
10054
|
+
* @param {number} [page] Page number
|
|
10055
|
+
* @param {*} [options] Override http request option.
|
|
10056
|
+
* @throws {RequiredError}
|
|
10057
|
+
* @memberof EcommerceProductVariantsApi
|
|
10058
|
+
*/
|
|
10059
|
+
listProductVariantsV1(storeId, productId, page, options) {
|
|
10060
|
+
return (0, exports.EcommerceProductVariantsApiFp)(this.configuration).listProductVariantsV1(storeId, productId, page, options).then((request) => request(this.axios, this.basePath));
|
|
10061
|
+
}
|
|
10062
|
+
/**
|
|
10063
|
+
* Update up to 100 existing variants in place by id — title, inventory, stock tracking and prices. Variants omitted from the request are left untouched. Prices replace the variant\'s existing prices in full. Returns the updated variants.
|
|
10064
|
+
* @summary Update product variants in batch
|
|
10065
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10066
|
+
* @param {string} productId The ID of the product whose variants are being updated.
|
|
10067
|
+
* @param {EcommerceV1VariantBatchUpdateVariantsRequest} ecommerceV1VariantBatchUpdateVariantsRequest
|
|
10068
|
+
* @param {*} [options] Override http request option.
|
|
10069
|
+
* @throws {RequiredError}
|
|
10070
|
+
* @memberof EcommerceProductVariantsApi
|
|
10071
|
+
*/
|
|
10072
|
+
updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options) {
|
|
10073
|
+
return (0, exports.EcommerceProductVariantsApiFp)(this.configuration).updateProductVariantsInBatchV1(storeId, productId, ecommerceV1VariantBatchUpdateVariantsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
8759
10074
|
}
|
|
8760
10075
|
}
|
|
8761
|
-
exports.
|
|
10076
|
+
exports.EcommerceProductVariantsApi = EcommerceProductVariantsApi;
|
|
8762
10077
|
/**
|
|
8763
10078
|
* EcommerceProductsApi - axios parameter creator
|
|
8764
10079
|
* @export
|
|
@@ -8875,6 +10190,135 @@ const EcommerceProductsApiAxiosParamCreator = function (configuration) {
|
|
|
8875
10190
|
options: localVarRequestOptions,
|
|
8876
10191
|
};
|
|
8877
10192
|
}),
|
|
10193
|
+
/**
|
|
10194
|
+
* Delete a product and its variants from the store. A subscription product with active subscribers is archived instead of deleted so its data stays available.
|
|
10195
|
+
* @summary Delete a product
|
|
10196
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10197
|
+
* @param {string} productId The ID of the product to delete.
|
|
10198
|
+
* @param {*} [options] Override http request option.
|
|
10199
|
+
* @throws {RequiredError}
|
|
10200
|
+
*/
|
|
10201
|
+
deleteAProductV1: (storeId_1, productId_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, ...args_1], void 0, function* (storeId, productId, options = {}) {
|
|
10202
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
10203
|
+
(0, common_1.assertParamExists)('deleteAProductV1', 'storeId', storeId);
|
|
10204
|
+
// verify required parameter 'productId' is not null or undefined
|
|
10205
|
+
(0, common_1.assertParamExists)('deleteAProductV1', 'productId', productId);
|
|
10206
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}`
|
|
10207
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
10208
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)));
|
|
10209
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10210
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10211
|
+
let baseOptions;
|
|
10212
|
+
if (configuration) {
|
|
10213
|
+
baseOptions = configuration.baseOptions;
|
|
10214
|
+
}
|
|
10215
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
10216
|
+
const localVarHeaderParameter = {};
|
|
10217
|
+
const localVarQueryParameter = {};
|
|
10218
|
+
// authentication apiToken required
|
|
10219
|
+
// http bearer authentication required
|
|
10220
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
10221
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10222
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10223
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10224
|
+
return {
|
|
10225
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10226
|
+
options: localVarRequestOptions,
|
|
10227
|
+
};
|
|
10228
|
+
}),
|
|
10229
|
+
/**
|
|
10230
|
+
* List a store\'s products newest first as lean summaries (name, status, thumbnail, variant count and price range). Prices are integers in the smallest currency unit and live on variants. Filter by status, free text or a set of product ids. Use include=variants to embed each product\'s variants with prices and inventory, and include=media to embed its media.
|
|
10231
|
+
* @summary List products
|
|
10232
|
+
* @param {string} storeId The ID of the store to list products for.
|
|
10233
|
+
* @param {Array<string>} [productIds] Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids.
|
|
10234
|
+
* @param {Array<ListProductsV1StatusEnum>} [status] Product statuses to include.
|
|
10235
|
+
* @param {string} [q] Free-text search over product title and SKU.
|
|
10236
|
+
* @param {Array<ListProductsV1IncludeEnum>} [include] Opt-in heavy data: \"variants\" embeds each product\'s variants; \"media\" embeds its media.
|
|
10237
|
+
* @param {number} [page] Page number
|
|
10238
|
+
* @param {*} [options] Override http request option.
|
|
10239
|
+
* @throws {RequiredError}
|
|
10240
|
+
*/
|
|
10241
|
+
listProductsV1: (storeId_1, productIds_1, status_1, q_1, include_1, page_1, ...args_1) => __awaiter(this, [storeId_1, productIds_1, status_1, q_1, include_1, page_1, ...args_1], void 0, function* (storeId, productIds, status, q, include, page, options = {}) {
|
|
10242
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
10243
|
+
(0, common_1.assertParamExists)('listProductsV1', 'storeId', storeId);
|
|
10244
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products`
|
|
10245
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
10246
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10247
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10248
|
+
let baseOptions;
|
|
10249
|
+
if (configuration) {
|
|
10250
|
+
baseOptions = configuration.baseOptions;
|
|
10251
|
+
}
|
|
10252
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
10253
|
+
const localVarHeaderParameter = {};
|
|
10254
|
+
const localVarQueryParameter = {};
|
|
10255
|
+
// authentication apiToken required
|
|
10256
|
+
// http bearer authentication required
|
|
10257
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
10258
|
+
if (productIds) {
|
|
10259
|
+
localVarQueryParameter['product_ids'] = productIds;
|
|
10260
|
+
}
|
|
10261
|
+
if (status) {
|
|
10262
|
+
localVarQueryParameter['status'] = status;
|
|
10263
|
+
}
|
|
10264
|
+
if (q !== undefined) {
|
|
10265
|
+
localVarQueryParameter['q'] = q;
|
|
10266
|
+
}
|
|
10267
|
+
if (include) {
|
|
10268
|
+
localVarQueryParameter['include'] = include;
|
|
10269
|
+
}
|
|
10270
|
+
if (page !== undefined) {
|
|
10271
|
+
localVarQueryParameter['page'] = page;
|
|
10272
|
+
}
|
|
10273
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10274
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10275
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10276
|
+
return {
|
|
10277
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10278
|
+
options: localVarRequestOptions,
|
|
10279
|
+
};
|
|
10280
|
+
}),
|
|
10281
|
+
/**
|
|
10282
|
+
* Update a product\'s name, description or status. Set status to published to make it buyable, draft to hide it, or archived to retire it. Variants, prices and inventory are managed through the variant endpoints, not here. Returns the updated product summary.
|
|
10283
|
+
* @summary Update a product
|
|
10284
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10285
|
+
* @param {string} productId The ID of the product to update.
|
|
10286
|
+
* @param {EcommerceV1ProductUpdateRequest} ecommerceV1ProductUpdateRequest
|
|
10287
|
+
* @param {*} [options] Override http request option.
|
|
10288
|
+
* @throws {RequiredError}
|
|
10289
|
+
*/
|
|
10290
|
+
updateAProductV1: (storeId_1, productId_1, ecommerceV1ProductUpdateRequest_1, ...args_1) => __awaiter(this, [storeId_1, productId_1, ecommerceV1ProductUpdateRequest_1, ...args_1], void 0, function* (storeId, productId, ecommerceV1ProductUpdateRequest, options = {}) {
|
|
10291
|
+
// verify required parameter 'storeId' is not null or undefined
|
|
10292
|
+
(0, common_1.assertParamExists)('updateAProductV1', 'storeId', storeId);
|
|
10293
|
+
// verify required parameter 'productId' is not null or undefined
|
|
10294
|
+
(0, common_1.assertParamExists)('updateAProductV1', 'productId', productId);
|
|
10295
|
+
// verify required parameter 'ecommerceV1ProductUpdateRequest' is not null or undefined
|
|
10296
|
+
(0, common_1.assertParamExists)('updateAProductV1', 'ecommerceV1ProductUpdateRequest', ecommerceV1ProductUpdateRequest);
|
|
10297
|
+
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/products/{product_id}`
|
|
10298
|
+
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)))
|
|
10299
|
+
.replace(`{${"product_id"}}`, encodeURIComponent(String(productId)));
|
|
10300
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10301
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10302
|
+
let baseOptions;
|
|
10303
|
+
if (configuration) {
|
|
10304
|
+
baseOptions = configuration.baseOptions;
|
|
10305
|
+
}
|
|
10306
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
10307
|
+
const localVarHeaderParameter = {};
|
|
10308
|
+
const localVarQueryParameter = {};
|
|
10309
|
+
// authentication apiToken required
|
|
10310
|
+
// http bearer authentication required
|
|
10311
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
10312
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10313
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10314
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10315
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10316
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(ecommerceV1ProductUpdateRequest, localVarRequestOptions, configuration);
|
|
10317
|
+
return {
|
|
10318
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10319
|
+
options: localVarRequestOptions,
|
|
10320
|
+
};
|
|
10321
|
+
}),
|
|
8878
10322
|
/**
|
|
8879
10323
|
* Fetch a raster image (JPEG, PNG, GIF or WebP, max 15MB) from a URL and attach it to a product in a single call. The image is virus-scanned and validated by content, then stored on the CDN. Set is_thumbnail to make it the product\'s primary image.
|
|
8880
10324
|
* @summary Upload and attach a product image
|
|
@@ -8950,27 +10394,80 @@ const EcommerceProductsApiFp = function (configuration) {
|
|
|
8950
10394
|
* @param {*} [options] Override http request option.
|
|
8951
10395
|
* @throws {RequiredError}
|
|
8952
10396
|
*/
|
|
8953
|
-
createDigitalProductV1(storeId, ecommerceV1ProductCreateDigitalProductRequest, options) {
|
|
10397
|
+
createDigitalProductV1(storeId, ecommerceV1ProductCreateDigitalProductRequest, options) {
|
|
10398
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
10399
|
+
var _a, _b;
|
|
10400
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createDigitalProductV1(storeId, ecommerceV1ProductCreateDigitalProductRequest, options);
|
|
10401
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.createDigitalProductV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
10402
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10403
|
+
});
|
|
10404
|
+
},
|
|
10405
|
+
/**
|
|
10406
|
+
* Create a published physical product with a single variant priced in the store currency.
|
|
10407
|
+
* @summary Create physical product
|
|
10408
|
+
* @param {string} storeId The ID of the store to create the product in.
|
|
10409
|
+
* @param {EcommerceV1ProductCreatePhysicalProductRequest} ecommerceV1ProductCreatePhysicalProductRequest
|
|
10410
|
+
* @param {*} [options] Override http request option.
|
|
10411
|
+
* @throws {RequiredError}
|
|
10412
|
+
*/
|
|
10413
|
+
createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options) {
|
|
10414
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
10415
|
+
var _a, _b;
|
|
10416
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options);
|
|
10417
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.createPhysicalProductV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
10418
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10419
|
+
});
|
|
10420
|
+
},
|
|
10421
|
+
/**
|
|
10422
|
+
* Delete a product and its variants from the store. A subscription product with active subscribers is archived instead of deleted so its data stays available.
|
|
10423
|
+
* @summary Delete a product
|
|
10424
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10425
|
+
* @param {string} productId The ID of the product to delete.
|
|
10426
|
+
* @param {*} [options] Override http request option.
|
|
10427
|
+
* @throws {RequiredError}
|
|
10428
|
+
*/
|
|
10429
|
+
deleteAProductV1(storeId, productId, options) {
|
|
10430
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
10431
|
+
var _a, _b;
|
|
10432
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteAProductV1(storeId, productId, options);
|
|
10433
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.deleteAProductV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
10434
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10435
|
+
});
|
|
10436
|
+
},
|
|
10437
|
+
/**
|
|
10438
|
+
* List a store\'s products newest first as lean summaries (name, status, thumbnail, variant count and price range). Prices are integers in the smallest currency unit and live on variants. Filter by status, free text or a set of product ids. Use include=variants to embed each product\'s variants with prices and inventory, and include=media to embed its media.
|
|
10439
|
+
* @summary List products
|
|
10440
|
+
* @param {string} storeId The ID of the store to list products for.
|
|
10441
|
+
* @param {Array<string>} [productIds] Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids.
|
|
10442
|
+
* @param {Array<ListProductsV1StatusEnum>} [status] Product statuses to include.
|
|
10443
|
+
* @param {string} [q] Free-text search over product title and SKU.
|
|
10444
|
+
* @param {Array<ListProductsV1IncludeEnum>} [include] Opt-in heavy data: \"variants\" embeds each product\'s variants; \"media\" embeds its media.
|
|
10445
|
+
* @param {number} [page] Page number
|
|
10446
|
+
* @param {*} [options] Override http request option.
|
|
10447
|
+
* @throws {RequiredError}
|
|
10448
|
+
*/
|
|
10449
|
+
listProductsV1(storeId, productIds, status, q, include, page, options) {
|
|
8954
10450
|
return __awaiter(this, void 0, void 0, function* () {
|
|
8955
10451
|
var _a, _b;
|
|
8956
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
8957
|
-
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.
|
|
10452
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductsV1(storeId, productIds, status, q, include, page, options);
|
|
10453
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.listProductsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
8958
10454
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8959
10455
|
});
|
|
8960
10456
|
},
|
|
8961
10457
|
/**
|
|
8962
|
-
*
|
|
8963
|
-
* @summary
|
|
8964
|
-
* @param {string} storeId The ID of the store
|
|
8965
|
-
* @param {
|
|
10458
|
+
* Update a product\'s name, description or status. Set status to published to make it buyable, draft to hide it, or archived to retire it. Variants, prices and inventory are managed through the variant endpoints, not here. Returns the updated product summary.
|
|
10459
|
+
* @summary Update a product
|
|
10460
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10461
|
+
* @param {string} productId The ID of the product to update.
|
|
10462
|
+
* @param {EcommerceV1ProductUpdateRequest} ecommerceV1ProductUpdateRequest
|
|
8966
10463
|
* @param {*} [options] Override http request option.
|
|
8967
10464
|
* @throws {RequiredError}
|
|
8968
10465
|
*/
|
|
8969
|
-
|
|
10466
|
+
updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options) {
|
|
8970
10467
|
return __awaiter(this, void 0, void 0, function* () {
|
|
8971
10468
|
var _a, _b;
|
|
8972
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
8973
|
-
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.
|
|
10469
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options);
|
|
10470
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceProductsApi.updateAProductV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
8974
10471
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8975
10472
|
});
|
|
8976
10473
|
},
|
|
@@ -9034,6 +10531,44 @@ const EcommerceProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
9034
10531
|
createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options) {
|
|
9035
10532
|
return localVarFp.createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options).then((request) => request(axios, basePath));
|
|
9036
10533
|
},
|
|
10534
|
+
/**
|
|
10535
|
+
* Delete a product and its variants from the store. A subscription product with active subscribers is archived instead of deleted so its data stays available.
|
|
10536
|
+
* @summary Delete a product
|
|
10537
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10538
|
+
* @param {string} productId The ID of the product to delete.
|
|
10539
|
+
* @param {*} [options] Override http request option.
|
|
10540
|
+
* @throws {RequiredError}
|
|
10541
|
+
*/
|
|
10542
|
+
deleteAProductV1(storeId, productId, options) {
|
|
10543
|
+
return localVarFp.deleteAProductV1(storeId, productId, options).then((request) => request(axios, basePath));
|
|
10544
|
+
},
|
|
10545
|
+
/**
|
|
10546
|
+
* List a store\'s products newest first as lean summaries (name, status, thumbnail, variant count and price range). Prices are integers in the smallest currency unit and live on variants. Filter by status, free text or a set of product ids. Use include=variants to embed each product\'s variants with prices and inventory, and include=media to embed its media.
|
|
10547
|
+
* @summary List products
|
|
10548
|
+
* @param {string} storeId The ID of the store to list products for.
|
|
10549
|
+
* @param {Array<string>} [productIds] Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids.
|
|
10550
|
+
* @param {Array<ListProductsV1StatusEnum>} [status] Product statuses to include.
|
|
10551
|
+
* @param {string} [q] Free-text search over product title and SKU.
|
|
10552
|
+
* @param {Array<ListProductsV1IncludeEnum>} [include] Opt-in heavy data: \"variants\" embeds each product\'s variants; \"media\" embeds its media.
|
|
10553
|
+
* @param {number} [page] Page number
|
|
10554
|
+
* @param {*} [options] Override http request option.
|
|
10555
|
+
* @throws {RequiredError}
|
|
10556
|
+
*/
|
|
10557
|
+
listProductsV1(storeId, productIds, status, q, include, page, options) {
|
|
10558
|
+
return localVarFp.listProductsV1(storeId, productIds, status, q, include, page, options).then((request) => request(axios, basePath));
|
|
10559
|
+
},
|
|
10560
|
+
/**
|
|
10561
|
+
* Update a product\'s name, description or status. Set status to published to make it buyable, draft to hide it, or archived to retire it. Variants, prices and inventory are managed through the variant endpoints, not here. Returns the updated product summary.
|
|
10562
|
+
* @summary Update a product
|
|
10563
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10564
|
+
* @param {string} productId The ID of the product to update.
|
|
10565
|
+
* @param {EcommerceV1ProductUpdateRequest} ecommerceV1ProductUpdateRequest
|
|
10566
|
+
* @param {*} [options] Override http request option.
|
|
10567
|
+
* @throws {RequiredError}
|
|
10568
|
+
*/
|
|
10569
|
+
updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options) {
|
|
10570
|
+
return localVarFp.updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options).then((request) => request(axios, basePath));
|
|
10571
|
+
},
|
|
9037
10572
|
/**
|
|
9038
10573
|
* Fetch a raster image (JPEG, PNG, GIF or WebP, max 15MB) from a URL and attach it to a product in a single call. The image is virus-scanned and validated by content, then stored on the CDN. Set is_thumbnail to make it the product\'s primary image.
|
|
9039
10574
|
* @summary Upload and attach a product image
|
|
@@ -9092,6 +10627,47 @@ class EcommerceProductsApi extends base_1.BaseAPI {
|
|
|
9092
10627
|
createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options) {
|
|
9093
10628
|
return (0, exports.EcommerceProductsApiFp)(this.configuration).createPhysicalProductV1(storeId, ecommerceV1ProductCreatePhysicalProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9094
10629
|
}
|
|
10630
|
+
/**
|
|
10631
|
+
* Delete a product and its variants from the store. A subscription product with active subscribers is archived instead of deleted so its data stays available.
|
|
10632
|
+
* @summary Delete a product
|
|
10633
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10634
|
+
* @param {string} productId The ID of the product to delete.
|
|
10635
|
+
* @param {*} [options] Override http request option.
|
|
10636
|
+
* @throws {RequiredError}
|
|
10637
|
+
* @memberof EcommerceProductsApi
|
|
10638
|
+
*/
|
|
10639
|
+
deleteAProductV1(storeId, productId, options) {
|
|
10640
|
+
return (0, exports.EcommerceProductsApiFp)(this.configuration).deleteAProductV1(storeId, productId, options).then((request) => request(this.axios, this.basePath));
|
|
10641
|
+
}
|
|
10642
|
+
/**
|
|
10643
|
+
* List a store\'s products newest first as lean summaries (name, status, thumbnail, variant count and price range). Prices are integers in the smallest currency unit and live on variants. Filter by status, free text or a set of product ids. Use include=variants to embed each product\'s variants with prices and inventory, and include=media to embed its media.
|
|
10644
|
+
* @summary List products
|
|
10645
|
+
* @param {string} storeId The ID of the store to list products for.
|
|
10646
|
+
* @param {Array<string>} [productIds] Restrict to these product ids. Doubles as a single-product lookup. Up to 200 ids.
|
|
10647
|
+
* @param {Array<ListProductsV1StatusEnum>} [status] Product statuses to include.
|
|
10648
|
+
* @param {string} [q] Free-text search over product title and SKU.
|
|
10649
|
+
* @param {Array<ListProductsV1IncludeEnum>} [include] Opt-in heavy data: \"variants\" embeds each product\'s variants; \"media\" embeds its media.
|
|
10650
|
+
* @param {number} [page] Page number
|
|
10651
|
+
* @param {*} [options] Override http request option.
|
|
10652
|
+
* @throws {RequiredError}
|
|
10653
|
+
* @memberof EcommerceProductsApi
|
|
10654
|
+
*/
|
|
10655
|
+
listProductsV1(storeId, productIds, status, q, include, page, options) {
|
|
10656
|
+
return (0, exports.EcommerceProductsApiFp)(this.configuration).listProductsV1(storeId, productIds, status, q, include, page, options).then((request) => request(this.axios, this.basePath));
|
|
10657
|
+
}
|
|
10658
|
+
/**
|
|
10659
|
+
* Update a product\'s name, description or status. Set status to published to make it buyable, draft to hide it, or archived to retire it. Variants, prices and inventory are managed through the variant endpoints, not here. Returns the updated product summary.
|
|
10660
|
+
* @summary Update a product
|
|
10661
|
+
* @param {string} storeId The ID of the store that owns the product.
|
|
10662
|
+
* @param {string} productId The ID of the product to update.
|
|
10663
|
+
* @param {EcommerceV1ProductUpdateRequest} ecommerceV1ProductUpdateRequest
|
|
10664
|
+
* @param {*} [options] Override http request option.
|
|
10665
|
+
* @throws {RequiredError}
|
|
10666
|
+
* @memberof EcommerceProductsApi
|
|
10667
|
+
*/
|
|
10668
|
+
updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options) {
|
|
10669
|
+
return (0, exports.EcommerceProductsApiFp)(this.configuration).updateAProductV1(storeId, productId, ecommerceV1ProductUpdateRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10670
|
+
}
|
|
9095
10671
|
/**
|
|
9096
10672
|
* Fetch a raster image (JPEG, PNG, GIF or WebP, max 15MB) from a URL and attach it to a product in a single call. The image is virus-scanned and validated by content, then stored on the CDN. Set is_thumbnail to make it the product\'s primary image.
|
|
9097
10673
|
* @summary Upload and attach a product image
|
|
@@ -9107,6 +10683,23 @@ class EcommerceProductsApi extends base_1.BaseAPI {
|
|
|
9107
10683
|
}
|
|
9108
10684
|
}
|
|
9109
10685
|
exports.EcommerceProductsApi = EcommerceProductsApi;
|
|
10686
|
+
/**
|
|
10687
|
+
* @export
|
|
10688
|
+
*/
|
|
10689
|
+
exports.ListProductsV1StatusEnum = {
|
|
10690
|
+
Draft: 'draft',
|
|
10691
|
+
Proposed: 'proposed',
|
|
10692
|
+
Published: 'published',
|
|
10693
|
+
Rejected: 'rejected',
|
|
10694
|
+
Archived: 'archived'
|
|
10695
|
+
};
|
|
10696
|
+
/**
|
|
10697
|
+
* @export
|
|
10698
|
+
*/
|
|
10699
|
+
exports.ListProductsV1IncludeEnum = {
|
|
10700
|
+
Variants: 'variants',
|
|
10701
|
+
Media: 'media'
|
|
10702
|
+
};
|
|
9110
10703
|
/**
|
|
9111
10704
|
* EcommerceSalesChannelsApi - axios parameter creator
|
|
9112
10705
|
* @export
|
|
@@ -9114,18 +10707,18 @@ exports.EcommerceProductsApi = EcommerceProductsApi;
|
|
|
9114
10707
|
const EcommerceSalesChannelsApiAxiosParamCreator = function (configuration) {
|
|
9115
10708
|
return {
|
|
9116
10709
|
/**
|
|
9117
|
-
* Create a
|
|
9118
|
-
* @summary Create
|
|
10710
|
+
* Create a sales channel for a store. A \"custom\" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A \"quick-link\" channel is a hosted one-page store whose handle is auto-generated.
|
|
10711
|
+
* @summary Create a sales channel
|
|
9119
10712
|
* @param {string} storeId The ID of the store to create the sales channel for.
|
|
9120
10713
|
* @param {EcommerceV1SalesChannelStoreRequest} ecommerceV1SalesChannelStoreRequest
|
|
9121
10714
|
* @param {*} [options] Override http request option.
|
|
9122
10715
|
* @throws {RequiredError}
|
|
9123
10716
|
*/
|
|
9124
|
-
|
|
10717
|
+
createASalesChannelV1: (storeId_1, ecommerceV1SalesChannelStoreRequest_1, ...args_1) => __awaiter(this, [storeId_1, ecommerceV1SalesChannelStoreRequest_1, ...args_1], void 0, function* (storeId, ecommerceV1SalesChannelStoreRequest, options = {}) {
|
|
9125
10718
|
// verify required parameter 'storeId' is not null or undefined
|
|
9126
|
-
(0, common_1.assertParamExists)('
|
|
10719
|
+
(0, common_1.assertParamExists)('createASalesChannelV1', 'storeId', storeId);
|
|
9127
10720
|
// verify required parameter 'ecommerceV1SalesChannelStoreRequest' is not null or undefined
|
|
9128
|
-
(0, common_1.assertParamExists)('
|
|
10721
|
+
(0, common_1.assertParamExists)('createASalesChannelV1', 'ecommerceV1SalesChannelStoreRequest', ecommerceV1SalesChannelStoreRequest);
|
|
9129
10722
|
const localVarPath = `/api/ecommerce/v1/stores/{store_id}/sales-channels`
|
|
9130
10723
|
.replace(`{${"store_id"}}`, encodeURIComponent(String(storeId)));
|
|
9131
10724
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -9234,18 +10827,18 @@ const EcommerceSalesChannelsApiFp = function (configuration) {
|
|
|
9234
10827
|
const localVarAxiosParamCreator = (0, exports.EcommerceSalesChannelsApiAxiosParamCreator)(configuration);
|
|
9235
10828
|
return {
|
|
9236
10829
|
/**
|
|
9237
|
-
* Create a
|
|
9238
|
-
* @summary Create
|
|
10830
|
+
* Create a sales channel for a store. A \"custom\" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A \"quick-link\" channel is a hosted one-page store whose handle is auto-generated.
|
|
10831
|
+
* @summary Create a sales channel
|
|
9239
10832
|
* @param {string} storeId The ID of the store to create the sales channel for.
|
|
9240
10833
|
* @param {EcommerceV1SalesChannelStoreRequest} ecommerceV1SalesChannelStoreRequest
|
|
9241
10834
|
* @param {*} [options] Override http request option.
|
|
9242
10835
|
* @throws {RequiredError}
|
|
9243
10836
|
*/
|
|
9244
|
-
|
|
10837
|
+
createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options) {
|
|
9245
10838
|
return __awaiter(this, void 0, void 0, function* () {
|
|
9246
10839
|
var _a, _b;
|
|
9247
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
9248
|
-
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceSalesChannelsApi.
|
|
10840
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options);
|
|
10841
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['EcommerceSalesChannelsApi.createASalesChannelV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
9249
10842
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9250
10843
|
});
|
|
9251
10844
|
},
|
|
@@ -9292,15 +10885,15 @@ const EcommerceSalesChannelsApiFactory = function (configuration, basePath, axio
|
|
|
9292
10885
|
const localVarFp = (0, exports.EcommerceSalesChannelsApiFp)(configuration);
|
|
9293
10886
|
return {
|
|
9294
10887
|
/**
|
|
9295
|
-
* Create a
|
|
9296
|
-
* @summary Create
|
|
10888
|
+
* Create a sales channel for a store. A \"custom\" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A \"quick-link\" channel is a hosted one-page store whose handle is auto-generated.
|
|
10889
|
+
* @summary Create a sales channel
|
|
9297
10890
|
* @param {string} storeId The ID of the store to create the sales channel for.
|
|
9298
10891
|
* @param {EcommerceV1SalesChannelStoreRequest} ecommerceV1SalesChannelStoreRequest
|
|
9299
10892
|
* @param {*} [options] Override http request option.
|
|
9300
10893
|
* @throws {RequiredError}
|
|
9301
10894
|
*/
|
|
9302
|
-
|
|
9303
|
-
return localVarFp.
|
|
10895
|
+
createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options) {
|
|
10896
|
+
return localVarFp.createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options).then((request) => request(axios, basePath));
|
|
9304
10897
|
},
|
|
9305
10898
|
/**
|
|
9306
10899
|
* List a store\'s active sales channels with their full metadata.
|
|
@@ -9335,16 +10928,16 @@ exports.EcommerceSalesChannelsApiFactory = EcommerceSalesChannelsApiFactory;
|
|
|
9335
10928
|
*/
|
|
9336
10929
|
class EcommerceSalesChannelsApi extends base_1.BaseAPI {
|
|
9337
10930
|
/**
|
|
9338
|
-
* Create a
|
|
9339
|
-
* @summary Create
|
|
10931
|
+
* Create a sales channel for a store. A \"custom\" channel is headless: build your own frontend and keep your catalog, orders, shipping and payments in sync through the Ecommerce API. A \"quick-link\" channel is a hosted one-page store whose handle is auto-generated.
|
|
10932
|
+
* @summary Create a sales channel
|
|
9340
10933
|
* @param {string} storeId The ID of the store to create the sales channel for.
|
|
9341
10934
|
* @param {EcommerceV1SalesChannelStoreRequest} ecommerceV1SalesChannelStoreRequest
|
|
9342
10935
|
* @param {*} [options] Override http request option.
|
|
9343
10936
|
* @throws {RequiredError}
|
|
9344
10937
|
* @memberof EcommerceSalesChannelsApi
|
|
9345
10938
|
*/
|
|
9346
|
-
|
|
9347
|
-
return (0, exports.EcommerceSalesChannelsApiFp)(this.configuration).
|
|
10939
|
+
createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options) {
|
|
10940
|
+
return (0, exports.EcommerceSalesChannelsApiFp)(this.configuration).createASalesChannelV1(storeId, ecommerceV1SalesChannelStoreRequest, options).then((request) => request(this.axios, this.basePath));
|
|
9348
10941
|
}
|
|
9349
10942
|
/**
|
|
9350
10943
|
* List a store\'s active sales channels with their full metadata.
|
|
@@ -12488,7 +14081,7 @@ const HostingNodeJSApiAxiosParamCreator = function (configuration) {
|
|
|
12488
14081
|
};
|
|
12489
14082
|
}),
|
|
12490
14083
|
/**
|
|
12491
|
-
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
14084
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
12492
14085
|
* @summary Get Node.js build settings from archive
|
|
12493
14086
|
* @param {string} username
|
|
12494
14087
|
* @param {string} domain Domain name
|
|
@@ -12695,7 +14288,7 @@ const HostingNodeJSApiAxiosParamCreator = function (configuration) {
|
|
|
12695
14288
|
};
|
|
12696
14289
|
}),
|
|
12697
14290
|
/**
|
|
12698
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint.
|
|
14291
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
12699
14292
|
* @summary Start Node.js build
|
|
12700
14293
|
* @param {string} username
|
|
12701
14294
|
* @param {string} domain Domain name
|
|
@@ -12764,7 +14357,7 @@ const HostingNodeJSApiFp = function (configuration) {
|
|
|
12764
14357
|
});
|
|
12765
14358
|
},
|
|
12766
14359
|
/**
|
|
12767
|
-
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
14360
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
12768
14361
|
* @summary Get Node.js build settings from archive
|
|
12769
14362
|
* @param {string} username
|
|
12770
14363
|
* @param {string} domain Domain name
|
|
@@ -12850,7 +14443,7 @@ const HostingNodeJSApiFp = function (configuration) {
|
|
|
12850
14443
|
});
|
|
12851
14444
|
},
|
|
12852
14445
|
/**
|
|
12853
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint.
|
|
14446
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
12854
14447
|
* @summary Start Node.js build
|
|
12855
14448
|
* @param {string} username
|
|
12856
14449
|
* @param {string} domain Domain name
|
|
@@ -12890,7 +14483,7 @@ const HostingNodeJSApiFactory = function (configuration, basePath, axios) {
|
|
|
12890
14483
|
return localVarFp.getNodeJSBuildLogsV1(username, domain, uuid, fromLine, options).then((request) => request(axios, basePath));
|
|
12891
14484
|
},
|
|
12892
14485
|
/**
|
|
12893
|
-
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
14486
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
12894
14487
|
* @summary Get Node.js build settings from archive
|
|
12895
14488
|
* @param {string} username
|
|
12896
14489
|
* @param {string} domain Domain name
|
|
@@ -12951,7 +14544,7 @@ const HostingNodeJSApiFactory = function (configuration, basePath, axios) {
|
|
|
12951
14544
|
return localVarFp.restartNodeJsApplicationV1(username, domain, options).then((request) => request(axios, basePath));
|
|
12952
14545
|
},
|
|
12953
14546
|
/**
|
|
12954
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint.
|
|
14547
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
12955
14548
|
* @summary Start Node.js build
|
|
12956
14549
|
* @param {string} username
|
|
12957
14550
|
* @param {string} domain Domain name
|
|
@@ -12987,7 +14580,7 @@ class HostingNodeJSApi extends base_1.BaseAPI {
|
|
|
12987
14580
|
return (0, exports.HostingNodeJSApiFp)(this.configuration).getNodeJSBuildLogsV1(username, domain, uuid, fromLine, options).then((request) => request(this.axios, this.basePath));
|
|
12988
14581
|
}
|
|
12989
14582
|
/**
|
|
12990
|
-
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
14583
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
12991
14584
|
* @summary Get Node.js build settings from archive
|
|
12992
14585
|
* @param {string} username
|
|
12993
14586
|
* @param {string} domain Domain name
|
|
@@ -13053,7 +14646,7 @@ class HostingNodeJSApi extends base_1.BaseAPI {
|
|
|
13053
14646
|
return (0, exports.HostingNodeJSApiFp)(this.configuration).restartNodeJsApplicationV1(username, domain, options).then((request) => request(this.axios, this.basePath));
|
|
13054
14647
|
}
|
|
13055
14648
|
/**
|
|
13056
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint.
|
|
14649
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
13057
14650
|
* @summary Start Node.js build
|
|
13058
14651
|
* @param {string} username
|
|
13059
14652
|
* @param {string} domain Domain name
|
|
@@ -20064,6 +21657,38 @@ exports.ReachFormsApi = ReachFormsApi;
|
|
|
20064
21657
|
*/
|
|
20065
21658
|
const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
20066
21659
|
return {
|
|
21660
|
+
/**
|
|
21661
|
+
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
21662
|
+
* @summary Get connected sending domain
|
|
21663
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21664
|
+
* @param {*} [options] Override http request option.
|
|
21665
|
+
* @throws {RequiredError}
|
|
21666
|
+
*/
|
|
21667
|
+
getConnectedSendingDomainV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
21668
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
21669
|
+
(0, common_1.assertParamExists)('getConnectedSendingDomainV1', 'profileUuid', profileUuid);
|
|
21670
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/domains`
|
|
21671
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
21672
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21673
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
21674
|
+
let baseOptions;
|
|
21675
|
+
if (configuration) {
|
|
21676
|
+
baseOptions = configuration.baseOptions;
|
|
21677
|
+
}
|
|
21678
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
21679
|
+
const localVarHeaderParameter = {};
|
|
21680
|
+
const localVarQueryParameter = {};
|
|
21681
|
+
// authentication apiToken required
|
|
21682
|
+
// http bearer authentication required
|
|
21683
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
21684
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
21685
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21686
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
21687
|
+
return {
|
|
21688
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
21689
|
+
options: localVarRequestOptions,
|
|
21690
|
+
};
|
|
21691
|
+
}),
|
|
20067
21692
|
/**
|
|
20068
21693
|
* Retrieve the DNS configuration status for a profile\'s domain. This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the actual records found and the suggested records required for correct email delivery.
|
|
20069
21694
|
* @summary Get profile domain DNS status
|
|
@@ -20128,6 +21753,38 @@ const ReachProfilesApiAxiosParamCreator = function (configuration) {
|
|
|
20128
21753
|
options: localVarRequestOptions,
|
|
20129
21754
|
};
|
|
20130
21755
|
}),
|
|
21756
|
+
/**
|
|
21757
|
+
* List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation.
|
|
21758
|
+
* @summary List plan feature access
|
|
21759
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21760
|
+
* @param {*} [options] Override http request option.
|
|
21761
|
+
* @throws {RequiredError}
|
|
21762
|
+
*/
|
|
21763
|
+
listPlanFeatureAccessV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
21764
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
21765
|
+
(0, common_1.assertParamExists)('listPlanFeatureAccessV1', 'profileUuid', profileUuid);
|
|
21766
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/features`
|
|
21767
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
21768
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21769
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
21770
|
+
let baseOptions;
|
|
21771
|
+
if (configuration) {
|
|
21772
|
+
baseOptions = configuration.baseOptions;
|
|
21773
|
+
}
|
|
21774
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
21775
|
+
const localVarHeaderParameter = {};
|
|
21776
|
+
const localVarQueryParameter = {};
|
|
21777
|
+
// authentication apiToken required
|
|
21778
|
+
// http bearer authentication required
|
|
21779
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
21780
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
21781
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21782
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
21783
|
+
return {
|
|
21784
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
21785
|
+
options: localVarRequestOptions,
|
|
21786
|
+
};
|
|
21787
|
+
}),
|
|
20131
21788
|
/**
|
|
20132
21789
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20133
21790
|
* @summary List Profiles
|
|
@@ -20166,6 +21823,21 @@ exports.ReachProfilesApiAxiosParamCreator = ReachProfilesApiAxiosParamCreator;
|
|
|
20166
21823
|
const ReachProfilesApiFp = function (configuration) {
|
|
20167
21824
|
const localVarAxiosParamCreator = (0, exports.ReachProfilesApiAxiosParamCreator)(configuration);
|
|
20168
21825
|
return {
|
|
21826
|
+
/**
|
|
21827
|
+
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
21828
|
+
* @summary Get connected sending domain
|
|
21829
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21830
|
+
* @param {*} [options] Override http request option.
|
|
21831
|
+
* @throws {RequiredError}
|
|
21832
|
+
*/
|
|
21833
|
+
getConnectedSendingDomainV1(profileUuid, options) {
|
|
21834
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21835
|
+
var _a, _b;
|
|
21836
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getConnectedSendingDomainV1(profileUuid, options);
|
|
21837
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.getConnectedSendingDomainV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
21838
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21839
|
+
});
|
|
21840
|
+
},
|
|
20169
21841
|
/**
|
|
20170
21842
|
* Retrieve the DNS configuration status for a profile\'s domain. This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the actual records found and the suggested records required for correct email delivery.
|
|
20171
21843
|
* @summary Get profile domain DNS status
|
|
@@ -20196,6 +21868,21 @@ const ReachProfilesApiFp = function (configuration) {
|
|
|
20196
21868
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20197
21869
|
});
|
|
20198
21870
|
},
|
|
21871
|
+
/**
|
|
21872
|
+
* List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation.
|
|
21873
|
+
* @summary List plan feature access
|
|
21874
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21875
|
+
* @param {*} [options] Override http request option.
|
|
21876
|
+
* @throws {RequiredError}
|
|
21877
|
+
*/
|
|
21878
|
+
listPlanFeatureAccessV1(profileUuid, options) {
|
|
21879
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21880
|
+
var _a, _b;
|
|
21881
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPlanFeatureAccessV1(profileUuid, options);
|
|
21882
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachProfilesApi.listPlanFeatureAccessV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
21883
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21884
|
+
});
|
|
21885
|
+
},
|
|
20199
21886
|
/**
|
|
20200
21887
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20201
21888
|
* @summary List Profiles
|
|
@@ -20220,6 +21907,16 @@ exports.ReachProfilesApiFp = ReachProfilesApiFp;
|
|
|
20220
21907
|
const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
20221
21908
|
const localVarFp = (0, exports.ReachProfilesApiFp)(configuration);
|
|
20222
21909
|
return {
|
|
21910
|
+
/**
|
|
21911
|
+
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
21912
|
+
* @summary Get connected sending domain
|
|
21913
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21914
|
+
* @param {*} [options] Override http request option.
|
|
21915
|
+
* @throws {RequiredError}
|
|
21916
|
+
*/
|
|
21917
|
+
getConnectedSendingDomainV1(profileUuid, options) {
|
|
21918
|
+
return localVarFp.getConnectedSendingDomainV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
21919
|
+
},
|
|
20223
21920
|
/**
|
|
20224
21921
|
* Retrieve the DNS configuration status for a profile\'s domain. This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the actual records found and the suggested records required for correct email delivery.
|
|
20225
21922
|
* @summary Get profile domain DNS status
|
|
@@ -20240,6 +21937,16 @@ const ReachProfilesApiFactory = function (configuration, basePath, axios) {
|
|
|
20240
21937
|
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
20241
21938
|
return localVarFp.getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
20242
21939
|
},
|
|
21940
|
+
/**
|
|
21941
|
+
* List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation.
|
|
21942
|
+
* @summary List plan feature access
|
|
21943
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21944
|
+
* @param {*} [options] Override http request option.
|
|
21945
|
+
* @throws {RequiredError}
|
|
21946
|
+
*/
|
|
21947
|
+
listPlanFeatureAccessV1(profileUuid, options) {
|
|
21948
|
+
return localVarFp.listPlanFeatureAccessV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
21949
|
+
},
|
|
20243
21950
|
/**
|
|
20244
21951
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20245
21952
|
* @summary List Profiles
|
|
@@ -20259,6 +21966,17 @@ exports.ReachProfilesApiFactory = ReachProfilesApiFactory;
|
|
|
20259
21966
|
* @extends {BaseAPI}
|
|
20260
21967
|
*/
|
|
20261
21968
|
class ReachProfilesApi extends base_1.BaseAPI {
|
|
21969
|
+
/**
|
|
21970
|
+
* Get the sending domain connected to the profile, its verification status and any suspended sender addresses. Campaigns only go out once a domain is connected and active, so this is the cheapest way to check that precondition before building one. A profile with no domain connected returns the same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records behind the status, use the DNS status endpoint.
|
|
21971
|
+
* @summary Get connected sending domain
|
|
21972
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
21973
|
+
* @param {*} [options] Override http request option.
|
|
21974
|
+
* @throws {RequiredError}
|
|
21975
|
+
* @memberof ReachProfilesApi
|
|
21976
|
+
*/
|
|
21977
|
+
getConnectedSendingDomainV1(profileUuid, options) {
|
|
21978
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).getConnectedSendingDomainV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
21979
|
+
}
|
|
20262
21980
|
/**
|
|
20263
21981
|
* Retrieve the DNS configuration status for a profile\'s domain. This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the actual records found and the suggested records required for correct email delivery.
|
|
20264
21982
|
* @summary Get profile domain DNS status
|
|
@@ -20281,6 +21999,17 @@ class ReachProfilesApi extends base_1.BaseAPI {
|
|
|
20281
21999
|
getRemainingPlanLimitsV1(profileUuid, options) {
|
|
20282
22000
|
return (0, exports.ReachProfilesApiFp)(this.configuration).getRemainingPlanLimitsV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
20283
22001
|
}
|
|
22002
|
+
/**
|
|
22003
|
+
* List which plan features the profile can use. This is the feature lock matrix, not a usage quota. `available` means the feature can be used right now and `locked` means it is not part of the base plan, so an upgrade is needed. For remaining emails, recipients and AI credits use the limits endpoint instead. Worth checking before building something that cannot be activated afterwards, such as an automation on a plan without automation activation.
|
|
22004
|
+
* @summary List plan feature access
|
|
22005
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22006
|
+
* @param {*} [options] Override http request option.
|
|
22007
|
+
* @throws {RequiredError}
|
|
22008
|
+
* @memberof ReachProfilesApi
|
|
22009
|
+
*/
|
|
22010
|
+
listPlanFeatureAccessV1(profileUuid, options) {
|
|
22011
|
+
return (0, exports.ReachProfilesApiFp)(this.configuration).listPlanFeatureAccessV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
22012
|
+
}
|
|
20284
22013
|
/**
|
|
20285
22014
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
20286
22015
|
* @summary List Profiles
|
|
@@ -20640,6 +22369,38 @@ const ReachSegmentsApiAxiosParamCreator = function (configuration) {
|
|
|
20640
22369
|
options: localVarRequestOptions,
|
|
20641
22370
|
};
|
|
20642
22371
|
}),
|
|
22372
|
+
/**
|
|
22373
|
+
* List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values. The list is profile specific: it includes the profile\'s custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22374
|
+
* @summary List segment filter attributes
|
|
22375
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22376
|
+
* @param {*} [options] Override http request option.
|
|
22377
|
+
* @throws {RequiredError}
|
|
22378
|
+
*/
|
|
22379
|
+
listSegmentFilterAttributesV1: (profileUuid_1, ...args_1) => __awaiter(this, [profileUuid_1, ...args_1], void 0, function* (profileUuid, options = {}) {
|
|
22380
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
22381
|
+
(0, common_1.assertParamExists)('listSegmentFilterAttributesV1', 'profileUuid', profileUuid);
|
|
22382
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes`
|
|
22383
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
22384
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22385
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
22386
|
+
let baseOptions;
|
|
22387
|
+
if (configuration) {
|
|
22388
|
+
baseOptions = configuration.baseOptions;
|
|
22389
|
+
}
|
|
22390
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
22391
|
+
const localVarHeaderParameter = {};
|
|
22392
|
+
const localVarQueryParameter = {};
|
|
22393
|
+
// authentication apiToken required
|
|
22394
|
+
// http bearer authentication required
|
|
22395
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
22396
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
22397
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22398
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
22399
|
+
return {
|
|
22400
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
22401
|
+
options: localVarRequestOptions,
|
|
22402
|
+
};
|
|
22403
|
+
}),
|
|
20643
22404
|
/**
|
|
20644
22405
|
* Get a list of all contact segments. This endpoint returns a list of contact segments that can be used to organize contacts. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client\'s default profile and cannot list the segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
20645
22406
|
* @summary List segments
|
|
@@ -20669,6 +22430,43 @@ const ReachSegmentsApiAxiosParamCreator = function (configuration) {
|
|
|
20669
22430
|
options: localVarRequestOptions,
|
|
20670
22431
|
};
|
|
20671
22432
|
}),
|
|
22433
|
+
/**
|
|
22434
|
+
* Preview the contacts matching a set of conditions without saving a segment. The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified. Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22435
|
+
* @summary Preview contacts matching conditions
|
|
22436
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22437
|
+
* @param {ReachV1ContactsSegmentsProfileFilterContactsRequest} reachV1ContactsSegmentsProfileFilterContactsRequest
|
|
22438
|
+
* @param {*} [options] Override http request option.
|
|
22439
|
+
* @throws {RequiredError}
|
|
22440
|
+
*/
|
|
22441
|
+
previewContactsMatchingConditionsV1: (profileUuid_1, reachV1ContactsSegmentsProfileFilterContactsRequest_1, ...args_1) => __awaiter(this, [profileUuid_1, reachV1ContactsSegmentsProfileFilterContactsRequest_1, ...args_1], void 0, function* (profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options = {}) {
|
|
22442
|
+
// verify required parameter 'profileUuid' is not null or undefined
|
|
22443
|
+
(0, common_1.assertParamExists)('previewContactsMatchingConditionsV1', 'profileUuid', profileUuid);
|
|
22444
|
+
// verify required parameter 'reachV1ContactsSegmentsProfileFilterContactsRequest' is not null or undefined
|
|
22445
|
+
(0, common_1.assertParamExists)('previewContactsMatchingConditionsV1', 'reachV1ContactsSegmentsProfileFilterContactsRequest', reachV1ContactsSegmentsProfileFilterContactsRequest);
|
|
22446
|
+
const localVarPath = `/api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts`
|
|
22447
|
+
.replace(`{${"profileUuid"}}`, encodeURIComponent(String(profileUuid)));
|
|
22448
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22449
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
22450
|
+
let baseOptions;
|
|
22451
|
+
if (configuration) {
|
|
22452
|
+
baseOptions = configuration.baseOptions;
|
|
22453
|
+
}
|
|
22454
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
22455
|
+
const localVarHeaderParameter = {};
|
|
22456
|
+
const localVarQueryParameter = {};
|
|
22457
|
+
// authentication apiToken required
|
|
22458
|
+
// http bearer authentication required
|
|
22459
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
22460
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
22461
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
22462
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22463
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
22464
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reachV1ContactsSegmentsProfileFilterContactsRequest, localVarRequestOptions, configuration);
|
|
22465
|
+
return {
|
|
22466
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
22467
|
+
options: localVarRequestOptions,
|
|
22468
|
+
};
|
|
22469
|
+
}),
|
|
20672
22470
|
/**
|
|
20673
22471
|
* Rename a segment and/or replace the conditions that define it. `name` is always required. Omit `conditions` to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately.
|
|
20674
22472
|
* @summary Update a profile segment
|
|
@@ -20870,6 +22668,21 @@ const ReachSegmentsApiFp = function (configuration) {
|
|
|
20870
22668
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20871
22669
|
});
|
|
20872
22670
|
},
|
|
22671
|
+
/**
|
|
22672
|
+
* List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values. The list is profile specific: it includes the profile\'s custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22673
|
+
* @summary List segment filter attributes
|
|
22674
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22675
|
+
* @param {*} [options] Override http request option.
|
|
22676
|
+
* @throws {RequiredError}
|
|
22677
|
+
*/
|
|
22678
|
+
listSegmentFilterAttributesV1(profileUuid, options) {
|
|
22679
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
22680
|
+
var _a, _b;
|
|
22681
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listSegmentFilterAttributesV1(profileUuid, options);
|
|
22682
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachSegmentsApi.listSegmentFilterAttributesV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
22683
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22684
|
+
});
|
|
22685
|
+
},
|
|
20873
22686
|
/**
|
|
20874
22687
|
* Get a list of all contact segments. This endpoint returns a list of contact segments that can be used to organize contacts. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client\'s default profile and cannot list the segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
20875
22688
|
* @summary List segments
|
|
@@ -20885,6 +22698,22 @@ const ReachSegmentsApiFp = function (configuration) {
|
|
|
20885
22698
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20886
22699
|
});
|
|
20887
22700
|
},
|
|
22701
|
+
/**
|
|
22702
|
+
* Preview the contacts matching a set of conditions without saving a segment. The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified. Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22703
|
+
* @summary Preview contacts matching conditions
|
|
22704
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22705
|
+
* @param {ReachV1ContactsSegmentsProfileFilterContactsRequest} reachV1ContactsSegmentsProfileFilterContactsRequest
|
|
22706
|
+
* @param {*} [options] Override http request option.
|
|
22707
|
+
* @throws {RequiredError}
|
|
22708
|
+
*/
|
|
22709
|
+
previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options) {
|
|
22710
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
22711
|
+
var _a, _b;
|
|
22712
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options);
|
|
22713
|
+
const localVarOperationServerBasePath = (_b = (_a = base_1.operationServerMap['ReachSegmentsApi.previewContactsMatchingConditionsV1']) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.url;
|
|
22714
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22715
|
+
});
|
|
22716
|
+
},
|
|
20888
22717
|
/**
|
|
20889
22718
|
* Rename a segment and/or replace the conditions that define it. `name` is always required. Omit `conditions` to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately.
|
|
20890
22719
|
* @summary Update a profile segment
|
|
@@ -21017,6 +22846,16 @@ const ReachSegmentsApiFactory = function (configuration, basePath, axios) {
|
|
|
21017
22846
|
listSegmentContactsV1(segmentUuid, page, perPage, options) {
|
|
21018
22847
|
return localVarFp.listSegmentContactsV1(segmentUuid, page, perPage, options).then((request) => request(axios, basePath));
|
|
21019
22848
|
},
|
|
22849
|
+
/**
|
|
22850
|
+
* List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values. The list is profile specific: it includes the profile\'s custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22851
|
+
* @summary List segment filter attributes
|
|
22852
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22853
|
+
* @param {*} [options] Override http request option.
|
|
22854
|
+
* @throws {RequiredError}
|
|
22855
|
+
*/
|
|
22856
|
+
listSegmentFilterAttributesV1(profileUuid, options) {
|
|
22857
|
+
return localVarFp.listSegmentFilterAttributesV1(profileUuid, options).then((request) => request(axios, basePath));
|
|
22858
|
+
},
|
|
21020
22859
|
/**
|
|
21021
22860
|
* Get a list of all contact segments. This endpoint returns a list of contact segments that can be used to organize contacts. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client\'s default profile and cannot list the segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
21022
22861
|
* @summary List segments
|
|
@@ -21027,6 +22866,17 @@ const ReachSegmentsApiFactory = function (configuration, basePath, axios) {
|
|
|
21027
22866
|
listSegmentsV1(options) {
|
|
21028
22867
|
return localVarFp.listSegmentsV1(options).then((request) => request(axios, basePath));
|
|
21029
22868
|
},
|
|
22869
|
+
/**
|
|
22870
|
+
* Preview the contacts matching a set of conditions without saving a segment. The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified. Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations.
|
|
22871
|
+
* @summary Preview contacts matching conditions
|
|
22872
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
22873
|
+
* @param {ReachV1ContactsSegmentsProfileFilterContactsRequest} reachV1ContactsSegmentsProfileFilterContactsRequest
|
|
22874
|
+
* @param {*} [options] Override http request option.
|
|
22875
|
+
* @throws {RequiredError}
|
|
22876
|
+
*/
|
|
22877
|
+
previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options) {
|
|
22878
|
+
return localVarFp.previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options).then((request) => request(axios, basePath));
|
|
22879
|
+
},
|
|
21030
22880
|
/**
|
|
21031
22881
|
* Rename a segment and/or replace the conditions that define it. `name` is always required. Omit `conditions` to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately.
|
|
21032
22882
|
* @summary Update a profile segment
|
|
@@ -21163,6 +23013,17 @@ class ReachSegmentsApi extends base_1.BaseAPI {
|
|
|
21163
23013
|
listSegmentContactsV1(segmentUuid, page, perPage, options) {
|
|
21164
23014
|
return (0, exports.ReachSegmentsApiFp)(this.configuration).listSegmentContactsV1(segmentUuid, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
21165
23015
|
}
|
|
23016
|
+
/**
|
|
23017
|
+
* List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values. The list is profile specific: it includes the profile\'s custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations.
|
|
23018
|
+
* @summary List segment filter attributes
|
|
23019
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
23020
|
+
* @param {*} [options] Override http request option.
|
|
23021
|
+
* @throws {RequiredError}
|
|
23022
|
+
* @memberof ReachSegmentsApi
|
|
23023
|
+
*/
|
|
23024
|
+
listSegmentFilterAttributesV1(profileUuid, options) {
|
|
23025
|
+
return (0, exports.ReachSegmentsApiFp)(this.configuration).listSegmentFilterAttributesV1(profileUuid, options).then((request) => request(this.axios, this.basePath));
|
|
23026
|
+
}
|
|
21166
23027
|
/**
|
|
21167
23028
|
* Get a list of all contact segments. This endpoint returns a list of contact segments that can be used to organize contacts. **Deprecated.** This endpoint cannot target a profile, so it always falls back to the client\'s default profile and cannot list the segments of any other profile. Use `GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
21168
23029
|
* @summary List segments
|
|
@@ -21174,6 +23035,18 @@ class ReachSegmentsApi extends base_1.BaseAPI {
|
|
|
21174
23035
|
listSegmentsV1(options) {
|
|
21175
23036
|
return (0, exports.ReachSegmentsApiFp)(this.configuration).listSegmentsV1(options).then((request) => request(this.axios, this.basePath));
|
|
21176
23037
|
}
|
|
23038
|
+
/**
|
|
23039
|
+
* Preview the contacts matching a set of conditions without saving a segment. The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified. Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations.
|
|
23040
|
+
* @summary Preview contacts matching conditions
|
|
23041
|
+
* @param {string} profileUuid Profile uuid parameter
|
|
23042
|
+
* @param {ReachV1ContactsSegmentsProfileFilterContactsRequest} reachV1ContactsSegmentsProfileFilterContactsRequest
|
|
23043
|
+
* @param {*} [options] Override http request option.
|
|
23044
|
+
* @throws {RequiredError}
|
|
23045
|
+
* @memberof ReachSegmentsApi
|
|
23046
|
+
*/
|
|
23047
|
+
previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options) {
|
|
23048
|
+
return (0, exports.ReachSegmentsApiFp)(this.configuration).previewContactsMatchingConditionsV1(profileUuid, reachV1ContactsSegmentsProfileFilterContactsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
23049
|
+
}
|
|
21177
23050
|
/**
|
|
21178
23051
|
* Rename a segment and/or replace the conditions that define it. `name` is always required. Omit `conditions` to rename without touching the conditions; supply them and they replace the existing set entirely rather than being merged into it. Contacts are never modified, but which of them match the segment can change immediately.
|
|
21179
23052
|
* @summary Update a profile segment
|