@streetlevel/api-clients 1.0.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/BUILD.bazel +118 -0
- package/generate.sh +91 -0
- package/openapi_ts.bzl +69 -0
- package/openapitools.json +7 -0
- package/package.json +23 -0
- package/src/generated/ad/.openapi-generator/FILES +25 -0
- package/src/generated/ad/.openapi-generator/VERSION +1 -0
- package/src/generated/ad/.openapi-generator-ignore +23 -0
- package/src/generated/ad/apis/AdsApi.ts +670 -0
- package/src/generated/ad/apis/index.ts +3 -0
- package/src/generated/ad/docs/AdResponse.md +61 -0
- package/src/generated/ad/docs/AdStatus.md +33 -0
- package/src/generated/ad/docs/AdsApi.md +560 -0
- package/src/generated/ad/docs/CreateAd400Response.md +41 -0
- package/src/generated/ad/docs/CreateAd400ResponseViolationsInner.md +37 -0
- package/src/generated/ad/docs/CreateAdRequest.md +45 -0
- package/src/generated/ad/docs/GetAd404Response.md +41 -0
- package/src/generated/ad/docs/ListAdsResponse.md +41 -0
- package/src/generated/ad/docs/RejectAdRequest.md +35 -0
- package/src/generated/ad/docs/UploadUrlResponse.md +39 -0
- package/src/generated/ad/index.ts +5 -0
- package/src/generated/ad/models/AdResponse.ts +185 -0
- package/src/generated/ad/models/AdStatus.ts +56 -0
- package/src/generated/ad/models/CreateAd400Response.ts +101 -0
- package/src/generated/ad/models/CreateAd400ResponseViolationsInner.ts +75 -0
- package/src/generated/ad/models/CreateAdRequest.ts +108 -0
- package/src/generated/ad/models/GetAd404Response.ts +92 -0
- package/src/generated/ad/models/ListAdsResponse.ts +101 -0
- package/src/generated/ad/models/RejectAdRequest.ts +66 -0
- package/src/generated/ad/models/UploadUrlResponse.ts +84 -0
- package/src/generated/ad/models/index.ts +11 -0
- package/src/generated/ad/runtime.ts +432 -0
- package/src/generated/adrequest/.openapi-generator/FILES +29 -0
- package/src/generated/adrequest/.openapi-generator/VERSION +1 -0
- package/src/generated/adrequest/.openapi-generator-ignore +23 -0
- package/src/generated/adrequest/apis/AdRequestsApi.ts +539 -0
- package/src/generated/adrequest/apis/index.ts +3 -0
- package/src/generated/adrequest/docs/AdForDisplay.md +43 -0
- package/src/generated/adrequest/docs/AdRequestResponse.md +53 -0
- package/src/generated/adrequest/docs/AdRequestStatus.md +33 -0
- package/src/generated/adrequest/docs/AdRequestsApi.md +430 -0
- package/src/generated/adrequest/docs/CreateAdRequest400Response.md +41 -0
- package/src/generated/adrequest/docs/CreateAdRequest400ResponseViolationsInner.md +37 -0
- package/src/generated/adrequest/docs/CreateAdRequestRequest.md +41 -0
- package/src/generated/adrequest/docs/FulfillAdRequestRequest.md +35 -0
- package/src/generated/adrequest/docs/GetAdRequest404Response.md +41 -0
- package/src/generated/adrequest/docs/GetNextAdsRequest.md +39 -0
- package/src/generated/adrequest/docs/ListAdRequestsResponse.md +41 -0
- package/src/generated/adrequest/docs/NextAdsResponse.md +41 -0
- package/src/generated/adrequest/index.ts +5 -0
- package/src/generated/adrequest/models/AdForDisplay.ts +101 -0
- package/src/generated/adrequest/models/AdRequestResponse.ts +151 -0
- package/src/generated/adrequest/models/AdRequestStatus.ts +55 -0
- package/src/generated/adrequest/models/CreateAdRequest400Response.ts +101 -0
- package/src/generated/adrequest/models/CreateAdRequest400ResponseViolationsInner.ts +75 -0
- package/src/generated/adrequest/models/CreateAdRequestRequest.ts +90 -0
- package/src/generated/adrequest/models/FulfillAdRequestRequest.ts +66 -0
- package/src/generated/adrequest/models/GetAdRequest404Response.ts +92 -0
- package/src/generated/adrequest/models/GetNextAdsRequest.ts +82 -0
- package/src/generated/adrequest/models/ListAdRequestsResponse.ts +101 -0
- package/src/generated/adrequest/models/NextAdsResponse.ts +99 -0
- package/src/generated/adrequest/models/index.ts +13 -0
- package/src/generated/adrequest/runtime.ts +432 -0
- package/src/generated/adset/.openapi-generator/FILES +23 -0
- package/src/generated/adset/.openapi-generator/VERSION +1 -0
- package/src/generated/adset/.openapi-generator-ignore +23 -0
- package/src/generated/adset/apis/AdSetsApi.ts +604 -0
- package/src/generated/adset/apis/index.ts +3 -0
- package/src/generated/adset/docs/AdSetResponse.md +49 -0
- package/src/generated/adset/docs/AdSetTargeting.md +37 -0
- package/src/generated/adset/docs/AdSetsApi.md +492 -0
- package/src/generated/adset/docs/CreateAdSet400Response.md +41 -0
- package/src/generated/adset/docs/CreateAdSet400ResponseViolationsInner.md +37 -0
- package/src/generated/adset/docs/CreateAdSetRequest.md +43 -0
- package/src/generated/adset/docs/GetAdSet404Response.md +41 -0
- package/src/generated/adset/docs/ListAdSetsResponse.md +41 -0
- package/src/generated/adset/docs/UpdateAdSetRequest.md +41 -0
- package/src/generated/adset/index.ts +5 -0
- package/src/generated/adset/models/AdSetResponse.ts +135 -0
- package/src/generated/adset/models/AdSetTargeting.ts +73 -0
- package/src/generated/adset/models/CreateAdSet400Response.ts +101 -0
- package/src/generated/adset/models/CreateAdSet400ResponseViolationsInner.ts +75 -0
- package/src/generated/adset/models/CreateAdSetRequest.ts +107 -0
- package/src/generated/adset/models/GetAdSet404Response.ts +92 -0
- package/src/generated/adset/models/ListAdSetsResponse.ts +101 -0
- package/src/generated/adset/models/UpdateAdSetRequest.ts +97 -0
- package/src/generated/adset/models/index.ts +10 -0
- package/src/generated/adset/runtime.ts +432 -0
- package/src/generated/campaign/.openapi-generator/FILES +23 -0
- package/src/generated/campaign/.openapi-generator/VERSION +1 -0
- package/src/generated/campaign/.openapi-generator-ignore +23 -0
- package/src/generated/campaign/apis/CampaignsApi.ts +808 -0
- package/src/generated/campaign/apis/index.ts +3 -0
- package/src/generated/campaign/docs/CampaignResponse.md +53 -0
- package/src/generated/campaign/docs/CampaignStatus.md +33 -0
- package/src/generated/campaign/docs/CampaignsApi.md +695 -0
- package/src/generated/campaign/docs/CreateCampaign400Response.md +41 -0
- package/src/generated/campaign/docs/CreateCampaign400ResponseViolationsInner.md +37 -0
- package/src/generated/campaign/docs/CreateCampaignRequest.md +45 -0
- package/src/generated/campaign/docs/GetCampaign404Response.md +41 -0
- package/src/generated/campaign/docs/ListCampaignsResponse.md +41 -0
- package/src/generated/campaign/docs/UpdateCampaignRequest.md +43 -0
- package/src/generated/campaign/index.ts +5 -0
- package/src/generated/campaign/models/CampaignResponse.ts +155 -0
- package/src/generated/campaign/models/CampaignStatus.ts +57 -0
- package/src/generated/campaign/models/CreateCampaign400Response.ts +101 -0
- package/src/generated/campaign/models/CreateCampaign400ResponseViolationsInner.ts +75 -0
- package/src/generated/campaign/models/CreateCampaignRequest.ts +109 -0
- package/src/generated/campaign/models/GetCampaign404Response.ts +92 -0
- package/src/generated/campaign/models/ListCampaignsResponse.ts +101 -0
- package/src/generated/campaign/models/UpdateCampaignRequest.ts +100 -0
- package/src/generated/campaign/models/index.ts +10 -0
- package/src/generated/campaign/runtime.ts +432 -0
- package/src/generated/car/.openapi-generator/FILES +27 -0
- package/src/generated/car/.openapi-generator/VERSION +1 -0
- package/src/generated/car/.openapi-generator-ignore +23 -0
- package/src/generated/car/apis/CarsApi.ts +680 -0
- package/src/generated/car/apis/index.ts +3 -0
- package/src/generated/car/docs/AssignDriverRequest.md +37 -0
- package/src/generated/car/docs/CarResponse.md +61 -0
- package/src/generated/car/docs/CarStatus.md +33 -0
- package/src/generated/car/docs/CarsApi.md +561 -0
- package/src/generated/car/docs/CreateCar400Response.md +41 -0
- package/src/generated/car/docs/CreateCar400ResponseViolationsInner.md +37 -0
- package/src/generated/car/docs/CreateCarRequest.md +51 -0
- package/src/generated/car/docs/GetCar404Response.md +41 -0
- package/src/generated/car/docs/ListCarsResponse.md +41 -0
- package/src/generated/car/docs/UpdateCarRequest.md +49 -0
- package/src/generated/car/docs/VehicleType.md +33 -0
- package/src/generated/car/index.ts +5 -0
- package/src/generated/car/models/AssignDriverRequest.ts +73 -0
- package/src/generated/car/models/CarResponse.ts +191 -0
- package/src/generated/car/models/CarStatus.ts +55 -0
- package/src/generated/car/models/CreateCar400Response.ts +101 -0
- package/src/generated/car/models/CreateCar400ResponseViolationsInner.ts +75 -0
- package/src/generated/car/models/CreateCarRequest.ts +140 -0
- package/src/generated/car/models/GetCar404Response.ts +92 -0
- package/src/generated/car/models/ListCarsResponse.ts +101 -0
- package/src/generated/car/models/UpdateCarRequest.ts +131 -0
- package/src/generated/car/models/VehicleType.ts +54 -0
- package/src/generated/car/models/index.ts +12 -0
- package/src/generated/car/runtime.ts +432 -0
- package/src/generated/carsupplier/.openapi-generator/FILES +21 -0
- package/src/generated/carsupplier/.openapi-generator/VERSION +1 -0
- package/src/generated/carsupplier/.openapi-generator-ignore +23 -0
- package/src/generated/carsupplier/apis/CarSuppliersApi.ts +582 -0
- package/src/generated/carsupplier/apis/index.ts +3 -0
- package/src/generated/carsupplier/docs/CarSupplierResponse.md +51 -0
- package/src/generated/carsupplier/docs/CarSuppliersApi.md +486 -0
- package/src/generated/carsupplier/docs/CreateCarSupplier400Response.md +41 -0
- package/src/generated/carsupplier/docs/CreateCarSupplier400ResponseViolationsInner.md +37 -0
- package/src/generated/carsupplier/docs/CreateCarSupplierRequest.md +43 -0
- package/src/generated/carsupplier/docs/GetCarSupplier404Response.md +41 -0
- package/src/generated/carsupplier/docs/ListCarSuppliersResponse.md +41 -0
- package/src/generated/carsupplier/docs/UpdateCarSupplierRequest.md +43 -0
- package/src/generated/carsupplier/index.ts +5 -0
- package/src/generated/carsupplier/models/CarSupplierResponse.ts +134 -0
- package/src/generated/carsupplier/models/CreateCarSupplier400Response.ts +101 -0
- package/src/generated/carsupplier/models/CreateCarSupplier400ResponseViolationsInner.ts +75 -0
- package/src/generated/carsupplier/models/CreateCarSupplierRequest.ts +98 -0
- package/src/generated/carsupplier/models/GetCarSupplier404Response.ts +92 -0
- package/src/generated/carsupplier/models/ListCarSuppliersResponse.ts +101 -0
- package/src/generated/carsupplier/models/UpdateCarSupplierRequest.ts +98 -0
- package/src/generated/carsupplier/models/index.ts +9 -0
- package/src/generated/carsupplier/runtime.ts +432 -0
- package/src/generated/client/.openapi-generator/FILES +25 -0
- package/src/generated/client/.openapi-generator/VERSION +1 -0
- package/src/generated/client/.openapi-generator-ignore +23 -0
- package/src/generated/client/apis/ClientsApi.ts +604 -0
- package/src/generated/client/apis/index.ts +3 -0
- package/src/generated/client/docs/AssignUserRequest.md +37 -0
- package/src/generated/client/docs/AssignUserToClient404Response.md +41 -0
- package/src/generated/client/docs/ClientResponse.md +43 -0
- package/src/generated/client/docs/ClientsApi.md +489 -0
- package/src/generated/client/docs/CreateClient400Response.md +41 -0
- package/src/generated/client/docs/CreateClient400ResponseViolationsInner.md +37 -0
- package/src/generated/client/docs/CreateClientRequest.md +37 -0
- package/src/generated/client/docs/ListClientsResponse.md +41 -0
- package/src/generated/client/docs/Role.md +33 -0
- package/src/generated/client/docs/UpdateClientRequest.md +35 -0
- package/src/generated/client/index.ts +5 -0
- package/src/generated/client/models/AssignUserRequest.ts +85 -0
- package/src/generated/client/models/AssignUserToClient404Response.ts +92 -0
- package/src/generated/client/models/ClientResponse.ts +101 -0
- package/src/generated/client/models/CreateClient400Response.ts +101 -0
- package/src/generated/client/models/CreateClient400ResponseViolationsInner.ts +75 -0
- package/src/generated/client/models/CreateClientRequest.ts +74 -0
- package/src/generated/client/models/ListClientsResponse.ts +101 -0
- package/src/generated/client/models/Role.ts +54 -0
- package/src/generated/client/models/UpdateClientRequest.ts +66 -0
- package/src/generated/client/models/index.ts +11 -0
- package/src/generated/client/runtime.ts +432 -0
- package/src/generated/clientzone/.openapi-generator/FILES +31 -0
- package/src/generated/clientzone/.openapi-generator/VERSION +1 -0
- package/src/generated/clientzone/.openapi-generator-ignore +23 -0
- package/src/generated/clientzone/apis/ClientZonesApi.ts +844 -0
- package/src/generated/clientzone/apis/index.ts +3 -0
- package/src/generated/clientzone/docs/ClientZoneItemResponse.md +49 -0
- package/src/generated/clientzone/docs/ClientZoneResponse.md +55 -0
- package/src/generated/clientzone/docs/ClientZoneStatus.md +33 -0
- package/src/generated/clientzone/docs/ClientZonesApi.md +700 -0
- package/src/generated/clientzone/docs/CreateClientZone400Response.md +41 -0
- package/src/generated/clientzone/docs/CreateClientZone400ResponseViolationsInner.md +37 -0
- package/src/generated/clientzone/docs/CreateClientZoneItemRequest.md +39 -0
- package/src/generated/clientzone/docs/CreateClientZoneRequest.md +43 -0
- package/src/generated/clientzone/docs/CreateClientZoneRequestActiveTimeRangesInner.md +37 -0
- package/src/generated/clientzone/docs/GetClientZone404Response.md +41 -0
- package/src/generated/clientzone/docs/ListClientZoneItemsResponse.md +35 -0
- package/src/generated/clientzone/docs/ListClientZonesResponse.md +41 -0
- package/src/generated/clientzone/docs/UpdateClientZoneRequest.md +39 -0
- package/src/generated/clientzone/index.ts +5 -0
- package/src/generated/clientzone/models/ClientZoneItemResponse.ts +129 -0
- package/src/generated/clientzone/models/ClientZoneResponse.ts +168 -0
- package/src/generated/clientzone/models/ClientZoneStatus.ts +53 -0
- package/src/generated/clientzone/models/CreateClientZone400Response.ts +101 -0
- package/src/generated/clientzone/models/CreateClientZone400ResponseViolationsInner.ts +75 -0
- package/src/generated/clientzone/models/CreateClientZoneItemRequest.ts +82 -0
- package/src/generated/clientzone/models/CreateClientZoneRequest.ts +107 -0
- package/src/generated/clientzone/models/CreateClientZoneRequestActiveTimeRangesInner.ts +75 -0
- package/src/generated/clientzone/models/GetClientZone404Response.ts +92 -0
- package/src/generated/clientzone/models/ListClientZoneItemsResponse.ts +74 -0
- package/src/generated/clientzone/models/ListClientZonesResponse.ts +101 -0
- package/src/generated/clientzone/models/UpdateClientZoneRequest.ts +89 -0
- package/src/generated/clientzone/models/index.ts +14 -0
- package/src/generated/clientzone/runtime.ts +432 -0
- package/src/generated/device/.openapi-generator/FILES +31 -0
- package/src/generated/device/.openapi-generator/VERSION +1 -0
- package/src/generated/device/.openapi-generator-ignore +23 -0
- package/src/generated/device/apis/DevicesApi.ts +905 -0
- package/src/generated/device/apis/index.ts +3 -0
- package/src/generated/device/docs/CreateDevice400Response.md +41 -0
- package/src/generated/device/docs/CreateDevice400ResponseViolationsInner.md +37 -0
- package/src/generated/device/docs/CreateDeviceRequest.md +45 -0
- package/src/generated/device/docs/DeviceDecommissionRequest.md +35 -0
- package/src/generated/device/docs/DeviceHeartbeatRequest.md +37 -0
- package/src/generated/device/docs/DeviceResponse.md +61 -0
- package/src/generated/device/docs/DeviceStatus.md +33 -0
- package/src/generated/device/docs/DevicesApi.md +764 -0
- package/src/generated/device/docs/GetDevice404Response.md +41 -0
- package/src/generated/device/docs/ListDevicesResponse.md +41 -0
- package/src/generated/device/docs/StartMaintenanceRequest.md +37 -0
- package/src/generated/device/docs/UpdateDeviceLocationRequest.md +45 -0
- package/src/generated/device/docs/UpdateDeviceRequest.md +41 -0
- package/src/generated/device/index.ts +5 -0
- package/src/generated/device/models/CreateDevice400Response.ts +101 -0
- package/src/generated/device/models/CreateDevice400ResponseViolationsInner.ts +75 -0
- package/src/generated/device/models/CreateDeviceRequest.ts +106 -0
- package/src/generated/device/models/DeviceDecommissionRequest.ts +65 -0
- package/src/generated/device/models/DeviceHeartbeatRequest.ts +73 -0
- package/src/generated/device/models/DeviceResponse.ts +184 -0
- package/src/generated/device/models/DeviceStatus.ts +55 -0
- package/src/generated/device/models/GetDevice404Response.ts +92 -0
- package/src/generated/device/models/ListDevicesResponse.ts +101 -0
- package/src/generated/device/models/StartMaintenanceRequest.ts +73 -0
- package/src/generated/device/models/UpdateDeviceLocationRequest.ts +105 -0
- package/src/generated/device/models/UpdateDeviceRequest.ts +99 -0
- package/src/generated/device/models/index.ts +14 -0
- package/src/generated/device/runtime.ts +432 -0
- package/src/generated/document/.openapi-generator/FILES +27 -0
- package/src/generated/document/.openapi-generator/VERSION +1 -0
- package/src/generated/document/.openapi-generator-ignore +23 -0
- package/src/generated/document/apis/DocumentsApi.ts +605 -0
- package/src/generated/document/apis/index.ts +3 -0
- package/src/generated/document/docs/CreateDocument400Response.md +41 -0
- package/src/generated/document/docs/CreateDocument400ResponseViolationsInner.md +37 -0
- package/src/generated/document/docs/CreateDocumentRequest.md +47 -0
- package/src/generated/document/docs/DocumentResponse.md +57 -0
- package/src/generated/document/docs/DocumentType.md +33 -0
- package/src/generated/document/docs/DocumentsApi.md +492 -0
- package/src/generated/document/docs/DownloadUrlResponse.md +37 -0
- package/src/generated/document/docs/GetDocument404Response.md +41 -0
- package/src/generated/document/docs/ListDocumentsResponse.md +41 -0
- package/src/generated/document/docs/UpdateDocumentRequest.md +39 -0
- package/src/generated/document/docs/UploadUrlResponse.md +39 -0
- package/src/generated/document/index.ts +5 -0
- package/src/generated/document/models/CreateDocument400Response.ts +101 -0
- package/src/generated/document/models/CreateDocument400ResponseViolationsInner.ts +75 -0
- package/src/generated/document/models/CreateDocumentRequest.ts +126 -0
- package/src/generated/document/models/DocumentResponse.ts +169 -0
- package/src/generated/document/models/DocumentType.ts +56 -0
- package/src/generated/document/models/DownloadUrlResponse.ts +75 -0
- package/src/generated/document/models/GetDocument404Response.ts +92 -0
- package/src/generated/document/models/ListDocumentsResponse.ts +101 -0
- package/src/generated/document/models/UpdateDocumentRequest.ts +92 -0
- package/src/generated/document/models/UploadUrlResponse.ts +84 -0
- package/src/generated/document/models/index.ts +12 -0
- package/src/generated/document/runtime.ts +432 -0
- package/src/generated/playlist/.openapi-generator/FILES +25 -0
- package/src/generated/playlist/.openapi-generator/VERSION +1 -0
- package/src/generated/playlist/.openapi-generator-ignore +23 -0
- package/src/generated/playlist/apis/PlaylistsApi.ts +585 -0
- package/src/generated/playlist/apis/index.ts +3 -0
- package/src/generated/playlist/docs/CreatePlaylist400Response.md +41 -0
- package/src/generated/playlist/docs/CreatePlaylist400ResponseViolationsInner.md +37 -0
- package/src/generated/playlist/docs/CreatePlaylistRequest.md +39 -0
- package/src/generated/playlist/docs/GetPlaylist404Response.md +41 -0
- package/src/generated/playlist/docs/ListPlaylistsResponse.md +41 -0
- package/src/generated/playlist/docs/PlaylistAd.md +43 -0
- package/src/generated/playlist/docs/PlaylistAdInput.md +39 -0
- package/src/generated/playlist/docs/PlaylistResponse.md +51 -0
- package/src/generated/playlist/docs/PlaylistsApi.md +489 -0
- package/src/generated/playlist/docs/UpdatePlaylistRequest.md +39 -0
- package/src/generated/playlist/index.ts +5 -0
- package/src/generated/playlist/models/CreatePlaylist400Response.ts +101 -0
- package/src/generated/playlist/models/CreatePlaylist400ResponseViolationsInner.ts +75 -0
- package/src/generated/playlist/models/CreatePlaylistRequest.ts +90 -0
- package/src/generated/playlist/models/GetPlaylist404Response.ts +92 -0
- package/src/generated/playlist/models/ListPlaylistsResponse.ts +101 -0
- package/src/generated/playlist/models/PlaylistAd.ts +101 -0
- package/src/generated/playlist/models/PlaylistAdInput.ts +84 -0
- package/src/generated/playlist/models/PlaylistResponse.ts +143 -0
- package/src/generated/playlist/models/UpdatePlaylistRequest.ts +89 -0
- package/src/generated/playlist/models/index.ts +11 -0
- package/src/generated/playlist/runtime.ts +432 -0
- package/src/generated/rate/.openapi-generator/FILES +33 -0
- package/src/generated/rate/.openapi-generator/VERSION +1 -0
- package/src/generated/rate/.openapi-generator-ignore +23 -0
- package/src/generated/rate/apis/RatesApi.ts +910 -0
- package/src/generated/rate/apis/index.ts +3 -0
- package/src/generated/rate/docs/CalculatePriceRequest.md +39 -0
- package/src/generated/rate/docs/CalculatePriceResponse.md +45 -0
- package/src/generated/rate/docs/CreateRate400Response.md +41 -0
- package/src/generated/rate/docs/CreateRate400ResponseViolationsInner.md +37 -0
- package/src/generated/rate/docs/CreateRateRequest.md +43 -0
- package/src/generated/rate/docs/CreateRateZoneRequest.md +39 -0
- package/src/generated/rate/docs/GetRate404Response.md +41 -0
- package/src/generated/rate/docs/ListRateZonesResponse.md +35 -0
- package/src/generated/rate/docs/ListRatesResponse.md +41 -0
- package/src/generated/rate/docs/RatePeriod.md +33 -0
- package/src/generated/rate/docs/RateResponse.md +51 -0
- package/src/generated/rate/docs/RateZoneResponse.md +49 -0
- package/src/generated/rate/docs/RatesApi.md +761 -0
- package/src/generated/rate/docs/UpdateRateRequest.md +41 -0
- package/src/generated/rate/index.ts +5 -0
- package/src/generated/rate/models/CalculatePriceRequest.ts +83 -0
- package/src/generated/rate/models/CalculatePriceResponse.ts +109 -0
- package/src/generated/rate/models/CreateRate400Response.ts +101 -0
- package/src/generated/rate/models/CreateRate400ResponseViolationsInner.ts +75 -0
- package/src/generated/rate/models/CreateRateRequest.ts +110 -0
- package/src/generated/rate/models/CreateRateZoneRequest.ts +83 -0
- package/src/generated/rate/models/GetRate404Response.ts +92 -0
- package/src/generated/rate/models/ListRateZonesResponse.ts +74 -0
- package/src/generated/rate/models/ListRatesResponse.ts +101 -0
- package/src/generated/rate/models/RatePeriod.ts +55 -0
- package/src/generated/rate/models/RateResponse.ts +147 -0
- package/src/generated/rate/models/RateZoneResponse.ts +128 -0
- package/src/generated/rate/models/UpdateRateRequest.ts +101 -0
- package/src/generated/rate/models/index.ts +15 -0
- package/src/generated/rate/runtime.ts +432 -0
- package/src/generated/settings/.openapi-generator/FILES +17 -0
- package/src/generated/settings/.openapi-generator/VERSION +1 -0
- package/src/generated/settings/.openapi-generator-ignore +23 -0
- package/src/generated/settings/apis/SettingsApi.ts +183 -0
- package/src/generated/settings/apis/index.ts +3 -0
- package/src/generated/settings/docs/AdDisplayMode.md +33 -0
- package/src/generated/settings/docs/SettingsApi.md +137 -0
- package/src/generated/settings/docs/SettingsResponse.md +43 -0
- package/src/generated/settings/docs/UpdateSettings400Response.md +41 -0
- package/src/generated/settings/docs/UpdateSettings400ResponseViolationsInner.md +37 -0
- package/src/generated/settings/docs/UpdateSettingsRequest.md +37 -0
- package/src/generated/settings/index.ts +5 -0
- package/src/generated/settings/models/AdDisplayMode.ts +56 -0
- package/src/generated/settings/models/SettingsResponse.ts +109 -0
- package/src/generated/settings/models/UpdateSettings400Response.ts +101 -0
- package/src/generated/settings/models/UpdateSettings400ResponseViolationsInner.ts +75 -0
- package/src/generated/settings/models/UpdateSettingsRequest.ts +84 -0
- package/src/generated/settings/models/index.ts +7 -0
- package/src/generated/settings/runtime.ts +432 -0
- package/src/generated/zone/.openapi-generator/FILES +37 -0
- package/src/generated/zone/.openapi-generator/VERSION +1 -0
- package/src/generated/zone/.openapi-generator-ignore +23 -0
- package/src/generated/zone/apis/ZonesApi.ts +804 -0
- package/src/generated/zone/apis/index.ts +3 -0
- package/src/generated/zone/docs/CheckPointInZonesRequest.md +37 -0
- package/src/generated/zone/docs/CreateZone400Response.md +41 -0
- package/src/generated/zone/docs/CreateZone400ResponseViolationsInner.md +37 -0
- package/src/generated/zone/docs/CreateZoneRequest.md +47 -0
- package/src/generated/zone/docs/CreateZoneRequestCenter.md +37 -0
- package/src/generated/zone/docs/GeoJsonPolygon.md +37 -0
- package/src/generated/zone/docs/GetZone404Response.md +41 -0
- package/src/generated/zone/docs/ListZonesResponse.md +41 -0
- package/src/generated/zone/docs/SyncZonesResponse.md +43 -0
- package/src/generated/zone/docs/Terminal.md +45 -0
- package/src/generated/zone/docs/UpdateZoneRequest.md +37 -0
- package/src/generated/zone/docs/ZoneResponse.md +65 -0
- package/src/generated/zone/docs/ZoneResponseCenter.md +37 -0
- package/src/generated/zone/docs/ZoneTerminalsResponse.md +37 -0
- package/src/generated/zone/docs/ZonesApi.md +682 -0
- package/src/generated/zone/docs/ZonesContainingPointResponse.md +35 -0
- package/src/generated/zone/index.ts +5 -0
- package/src/generated/zone/models/CheckPointInZonesRequest.ts +75 -0
- package/src/generated/zone/models/CreateZone400Response.ts +101 -0
- package/src/generated/zone/models/CreateZone400ResponseViolationsInner.ts +75 -0
- package/src/generated/zone/models/CreateZoneRequest.ts +129 -0
- package/src/generated/zone/models/CreateZoneRequestCenter.ts +75 -0
- package/src/generated/zone/models/GeoJsonPolygon.ts +73 -0
- package/src/generated/zone/models/GetZone404Response.ts +92 -0
- package/src/generated/zone/models/ListZonesResponse.ts +101 -0
- package/src/generated/zone/models/SyncZonesResponse.ts +109 -0
- package/src/generated/zone/models/Terminal.ts +120 -0
- package/src/generated/zone/models/UpdateZoneRequest.ts +74 -0
- package/src/generated/zone/models/ZoneResponse.ts +207 -0
- package/src/generated/zone/models/ZoneResponseCenter.ts +75 -0
- package/src/generated/zone/models/ZoneTerminalsResponse.ts +83 -0
- package/src/generated/zone/models/ZonesContainingPointResponse.ts +74 -0
- package/src/generated/zone/models/index.ts +17 -0
- package/src/generated/zone/runtime.ts +432 -0
- package/src/index.ts +38 -0
- package/tsconfig.json +17 -0
|
@@ -0,0 +1,604 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Street Level - Ad Set API
|
|
5
|
+
* API for managing ad sets (groups of ads)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import * as runtime from '../runtime';
|
|
17
|
+
import type {
|
|
18
|
+
AdSetResponse,
|
|
19
|
+
CreateAdSet400Response,
|
|
20
|
+
CreateAdSetRequest,
|
|
21
|
+
GetAdSet404Response,
|
|
22
|
+
ListAdSetsResponse,
|
|
23
|
+
UpdateAdSetRequest,
|
|
24
|
+
} from '../models/index';
|
|
25
|
+
import {
|
|
26
|
+
AdSetResponseFromJSON,
|
|
27
|
+
AdSetResponseToJSON,
|
|
28
|
+
CreateAdSet400ResponseFromJSON,
|
|
29
|
+
CreateAdSet400ResponseToJSON,
|
|
30
|
+
CreateAdSetRequestFromJSON,
|
|
31
|
+
CreateAdSetRequestToJSON,
|
|
32
|
+
GetAdSet404ResponseFromJSON,
|
|
33
|
+
GetAdSet404ResponseToJSON,
|
|
34
|
+
ListAdSetsResponseFromJSON,
|
|
35
|
+
ListAdSetsResponseToJSON,
|
|
36
|
+
UpdateAdSetRequestFromJSON,
|
|
37
|
+
UpdateAdSetRequestToJSON,
|
|
38
|
+
} from '../models/index';
|
|
39
|
+
|
|
40
|
+
export interface AddAdToSetRequest {
|
|
41
|
+
adsetId: string;
|
|
42
|
+
adId: string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface CreateAdSetOperationRequest {
|
|
46
|
+
createAdSetRequest: CreateAdSetRequest;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export interface DeleteAdSetRequest {
|
|
50
|
+
adsetId: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export interface GetAdSetRequest {
|
|
54
|
+
adsetId: string;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export interface ListAdSetsRequest {
|
|
58
|
+
campaignId?: string;
|
|
59
|
+
offset?: number;
|
|
60
|
+
limit?: number;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export interface RemoveAdFromSetRequest {
|
|
64
|
+
adsetId: string;
|
|
65
|
+
adId: string;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface UpdateAdSetOperationRequest {
|
|
69
|
+
adsetId: string;
|
|
70
|
+
updateAdSetRequest: UpdateAdSetRequest;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* AdSetsApi - interface
|
|
75
|
+
*
|
|
76
|
+
* @export
|
|
77
|
+
* @interface AdSetsApiInterface
|
|
78
|
+
*/
|
|
79
|
+
export interface AdSetsApiInterface {
|
|
80
|
+
/**
|
|
81
|
+
* Creates request options for addAdToSet without sending the request
|
|
82
|
+
* @param {string} adsetId
|
|
83
|
+
* @param {string} adId
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
* @memberof AdSetsApiInterface
|
|
86
|
+
*/
|
|
87
|
+
addAdToSetRequestOpts(requestParameters: AddAdToSetRequest): Promise<runtime.RequestOpts>;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @summary Add an ad to the set
|
|
92
|
+
* @param {string} adsetId
|
|
93
|
+
* @param {string} adId
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
* @memberof AdSetsApiInterface
|
|
97
|
+
*/
|
|
98
|
+
addAdToSetRaw(requestParameters: AddAdToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>>;
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Add an ad to the set
|
|
102
|
+
*/
|
|
103
|
+
addAdToSet(requestParameters: AddAdToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse>;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Creates request options for createAdSet without sending the request
|
|
107
|
+
* @param {CreateAdSetRequest} createAdSetRequest
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
* @memberof AdSetsApiInterface
|
|
110
|
+
*/
|
|
111
|
+
createAdSetRequestOpts(requestParameters: CreateAdSetOperationRequest): Promise<runtime.RequestOpts>;
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @summary Create a new ad set
|
|
116
|
+
* @param {CreateAdSetRequest} createAdSetRequest
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
* @memberof AdSetsApiInterface
|
|
120
|
+
*/
|
|
121
|
+
createAdSetRaw(requestParameters: CreateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>>;
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Create a new ad set
|
|
125
|
+
*/
|
|
126
|
+
createAdSet(requestParameters: CreateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse>;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Creates request options for deleteAdSet without sending the request
|
|
130
|
+
* @param {string} adsetId
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof AdSetsApiInterface
|
|
133
|
+
*/
|
|
134
|
+
deleteAdSetRequestOpts(requestParameters: DeleteAdSetRequest): Promise<runtime.RequestOpts>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @summary Delete an ad set
|
|
139
|
+
* @param {string} adsetId
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
* @memberof AdSetsApiInterface
|
|
143
|
+
*/
|
|
144
|
+
deleteAdSetRaw(requestParameters: DeleteAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* Delete an ad set
|
|
148
|
+
*/
|
|
149
|
+
deleteAdSet(requestParameters: DeleteAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Creates request options for getAdSet without sending the request
|
|
153
|
+
* @param {string} adsetId
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
* @memberof AdSetsApiInterface
|
|
156
|
+
*/
|
|
157
|
+
getAdSetRequestOpts(requestParameters: GetAdSetRequest): Promise<runtime.RequestOpts>;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @summary Get ad set by ID
|
|
162
|
+
* @param {string} adsetId
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
* @memberof AdSetsApiInterface
|
|
166
|
+
*/
|
|
167
|
+
getAdSetRaw(requestParameters: GetAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>>;
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Get ad set by ID
|
|
171
|
+
*/
|
|
172
|
+
getAdSet(requestParameters: GetAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse>;
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Creates request options for listAdSets without sending the request
|
|
176
|
+
* @param {string} [campaignId] Filter by campaign ID
|
|
177
|
+
* @param {number} [offset]
|
|
178
|
+
* @param {number} [limit]
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
* @memberof AdSetsApiInterface
|
|
181
|
+
*/
|
|
182
|
+
listAdSetsRequestOpts(requestParameters: ListAdSetsRequest): Promise<runtime.RequestOpts>;
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @summary List ad sets
|
|
187
|
+
* @param {string} [campaignId] Filter by campaign ID
|
|
188
|
+
* @param {number} [offset]
|
|
189
|
+
* @param {number} [limit]
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
* @memberof AdSetsApiInterface
|
|
193
|
+
*/
|
|
194
|
+
listAdSetsRaw(requestParameters: ListAdSetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdSetsResponse>>;
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* List ad sets
|
|
198
|
+
*/
|
|
199
|
+
listAdSets(requestParameters: ListAdSetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdSetsResponse>;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Creates request options for removeAdFromSet without sending the request
|
|
203
|
+
* @param {string} adsetId
|
|
204
|
+
* @param {string} adId
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
* @memberof AdSetsApiInterface
|
|
207
|
+
*/
|
|
208
|
+
removeAdFromSetRequestOpts(requestParameters: RemoveAdFromSetRequest): Promise<runtime.RequestOpts>;
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @summary Remove an ad from the set
|
|
213
|
+
* @param {string} adsetId
|
|
214
|
+
* @param {string} adId
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
* @memberof AdSetsApiInterface
|
|
218
|
+
*/
|
|
219
|
+
removeAdFromSetRaw(requestParameters: RemoveAdFromSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>>;
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Remove an ad from the set
|
|
223
|
+
*/
|
|
224
|
+
removeAdFromSet(requestParameters: RemoveAdFromSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse>;
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Creates request options for updateAdSet without sending the request
|
|
228
|
+
* @param {string} adsetId
|
|
229
|
+
* @param {UpdateAdSetRequest} updateAdSetRequest
|
|
230
|
+
* @throws {RequiredError}
|
|
231
|
+
* @memberof AdSetsApiInterface
|
|
232
|
+
*/
|
|
233
|
+
updateAdSetRequestOpts(requestParameters: UpdateAdSetOperationRequest): Promise<runtime.RequestOpts>;
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @summary Update an ad set
|
|
238
|
+
* @param {string} adsetId
|
|
239
|
+
* @param {UpdateAdSetRequest} updateAdSetRequest
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
* @memberof AdSetsApiInterface
|
|
243
|
+
*/
|
|
244
|
+
updateAdSetRaw(requestParameters: UpdateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>>;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Update an ad set
|
|
248
|
+
*/
|
|
249
|
+
updateAdSet(requestParameters: UpdateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse>;
|
|
250
|
+
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
*/
|
|
256
|
+
export class AdSetsApi extends runtime.BaseAPI implements AdSetsApiInterface {
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Creates request options for addAdToSet without sending the request
|
|
260
|
+
*/
|
|
261
|
+
async addAdToSetRequestOpts(requestParameters: AddAdToSetRequest): Promise<runtime.RequestOpts> {
|
|
262
|
+
if (requestParameters['adsetId'] == null) {
|
|
263
|
+
throw new runtime.RequiredError(
|
|
264
|
+
'adsetId',
|
|
265
|
+
'Required parameter "adsetId" was null or undefined when calling addAdToSet().'
|
|
266
|
+
);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
if (requestParameters['adId'] == null) {
|
|
270
|
+
throw new runtime.RequiredError(
|
|
271
|
+
'adId',
|
|
272
|
+
'Required parameter "adId" was null or undefined when calling addAdToSet().'
|
|
273
|
+
);
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
const queryParameters: any = {};
|
|
277
|
+
|
|
278
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
let urlPath = `/adsets/{adset_id}/ads/{ad_id}`;
|
|
282
|
+
urlPath = urlPath.replace(`{${"adset_id"}}`, encodeURIComponent(String(requestParameters['adsetId'])));
|
|
283
|
+
urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
|
|
284
|
+
|
|
285
|
+
return {
|
|
286
|
+
path: urlPath,
|
|
287
|
+
method: 'POST',
|
|
288
|
+
headers: headerParameters,
|
|
289
|
+
query: queryParameters,
|
|
290
|
+
};
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* Add an ad to the set
|
|
295
|
+
*/
|
|
296
|
+
async addAdToSetRaw(requestParameters: AddAdToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>> {
|
|
297
|
+
const requestOptions = await this.addAdToSetRequestOpts(requestParameters);
|
|
298
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
299
|
+
|
|
300
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AdSetResponseFromJSON(jsonValue));
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* Add an ad to the set
|
|
305
|
+
*/
|
|
306
|
+
async addAdToSet(requestParameters: AddAdToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse> {
|
|
307
|
+
const response = await this.addAdToSetRaw(requestParameters, initOverrides);
|
|
308
|
+
return await response.value();
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Creates request options for createAdSet without sending the request
|
|
313
|
+
*/
|
|
314
|
+
async createAdSetRequestOpts(requestParameters: CreateAdSetOperationRequest): Promise<runtime.RequestOpts> {
|
|
315
|
+
if (requestParameters['createAdSetRequest'] == null) {
|
|
316
|
+
throw new runtime.RequiredError(
|
|
317
|
+
'createAdSetRequest',
|
|
318
|
+
'Required parameter "createAdSetRequest" was null or undefined when calling createAdSet().'
|
|
319
|
+
);
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
const queryParameters: any = {};
|
|
323
|
+
|
|
324
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
325
|
+
|
|
326
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
let urlPath = `/adsets`;
|
|
330
|
+
|
|
331
|
+
return {
|
|
332
|
+
path: urlPath,
|
|
333
|
+
method: 'POST',
|
|
334
|
+
headers: headerParameters,
|
|
335
|
+
query: queryParameters,
|
|
336
|
+
body: CreateAdSetRequestToJSON(requestParameters['createAdSetRequest']),
|
|
337
|
+
};
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Create a new ad set
|
|
342
|
+
*/
|
|
343
|
+
async createAdSetRaw(requestParameters: CreateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>> {
|
|
344
|
+
const requestOptions = await this.createAdSetRequestOpts(requestParameters);
|
|
345
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
346
|
+
|
|
347
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AdSetResponseFromJSON(jsonValue));
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
/**
|
|
351
|
+
* Create a new ad set
|
|
352
|
+
*/
|
|
353
|
+
async createAdSet(requestParameters: CreateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse> {
|
|
354
|
+
const response = await this.createAdSetRaw(requestParameters, initOverrides);
|
|
355
|
+
return await response.value();
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Creates request options for deleteAdSet without sending the request
|
|
360
|
+
*/
|
|
361
|
+
async deleteAdSetRequestOpts(requestParameters: DeleteAdSetRequest): Promise<runtime.RequestOpts> {
|
|
362
|
+
if (requestParameters['adsetId'] == null) {
|
|
363
|
+
throw new runtime.RequiredError(
|
|
364
|
+
'adsetId',
|
|
365
|
+
'Required parameter "adsetId" was null or undefined when calling deleteAdSet().'
|
|
366
|
+
);
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
const queryParameters: any = {};
|
|
370
|
+
|
|
371
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
let urlPath = `/adsets/{adset_id}`;
|
|
375
|
+
urlPath = urlPath.replace(`{${"adset_id"}}`, encodeURIComponent(String(requestParameters['adsetId'])));
|
|
376
|
+
|
|
377
|
+
return {
|
|
378
|
+
path: urlPath,
|
|
379
|
+
method: 'DELETE',
|
|
380
|
+
headers: headerParameters,
|
|
381
|
+
query: queryParameters,
|
|
382
|
+
};
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Delete an ad set
|
|
387
|
+
*/
|
|
388
|
+
async deleteAdSetRaw(requestParameters: DeleteAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
389
|
+
const requestOptions = await this.deleteAdSetRequestOpts(requestParameters);
|
|
390
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
391
|
+
|
|
392
|
+
return new runtime.VoidApiResponse(response);
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* Delete an ad set
|
|
397
|
+
*/
|
|
398
|
+
async deleteAdSet(requestParameters: DeleteAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
399
|
+
await this.deleteAdSetRaw(requestParameters, initOverrides);
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
/**
|
|
403
|
+
* Creates request options for getAdSet without sending the request
|
|
404
|
+
*/
|
|
405
|
+
async getAdSetRequestOpts(requestParameters: GetAdSetRequest): Promise<runtime.RequestOpts> {
|
|
406
|
+
if (requestParameters['adsetId'] == null) {
|
|
407
|
+
throw new runtime.RequiredError(
|
|
408
|
+
'adsetId',
|
|
409
|
+
'Required parameter "adsetId" was null or undefined when calling getAdSet().'
|
|
410
|
+
);
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
const queryParameters: any = {};
|
|
414
|
+
|
|
415
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
let urlPath = `/adsets/{adset_id}`;
|
|
419
|
+
urlPath = urlPath.replace(`{${"adset_id"}}`, encodeURIComponent(String(requestParameters['adsetId'])));
|
|
420
|
+
|
|
421
|
+
return {
|
|
422
|
+
path: urlPath,
|
|
423
|
+
method: 'GET',
|
|
424
|
+
headers: headerParameters,
|
|
425
|
+
query: queryParameters,
|
|
426
|
+
};
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
/**
|
|
430
|
+
* Get ad set by ID
|
|
431
|
+
*/
|
|
432
|
+
async getAdSetRaw(requestParameters: GetAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>> {
|
|
433
|
+
const requestOptions = await this.getAdSetRequestOpts(requestParameters);
|
|
434
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
435
|
+
|
|
436
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AdSetResponseFromJSON(jsonValue));
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* Get ad set by ID
|
|
441
|
+
*/
|
|
442
|
+
async getAdSet(requestParameters: GetAdSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse> {
|
|
443
|
+
const response = await this.getAdSetRaw(requestParameters, initOverrides);
|
|
444
|
+
return await response.value();
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* Creates request options for listAdSets without sending the request
|
|
449
|
+
*/
|
|
450
|
+
async listAdSetsRequestOpts(requestParameters: ListAdSetsRequest): Promise<runtime.RequestOpts> {
|
|
451
|
+
const queryParameters: any = {};
|
|
452
|
+
|
|
453
|
+
if (requestParameters['campaignId'] != null) {
|
|
454
|
+
queryParameters['campaign_id'] = requestParameters['campaignId'];
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
if (requestParameters['offset'] != null) {
|
|
458
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
if (requestParameters['limit'] != null) {
|
|
462
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
let urlPath = `/adsets`;
|
|
469
|
+
|
|
470
|
+
return {
|
|
471
|
+
path: urlPath,
|
|
472
|
+
method: 'GET',
|
|
473
|
+
headers: headerParameters,
|
|
474
|
+
query: queryParameters,
|
|
475
|
+
};
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* List ad sets
|
|
480
|
+
*/
|
|
481
|
+
async listAdSetsRaw(requestParameters: ListAdSetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAdSetsResponse>> {
|
|
482
|
+
const requestOptions = await this.listAdSetsRequestOpts(requestParameters);
|
|
483
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
484
|
+
|
|
485
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListAdSetsResponseFromJSON(jsonValue));
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
/**
|
|
489
|
+
* List ad sets
|
|
490
|
+
*/
|
|
491
|
+
async listAdSets(requestParameters: ListAdSetsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAdSetsResponse> {
|
|
492
|
+
const response = await this.listAdSetsRaw(requestParameters, initOverrides);
|
|
493
|
+
return await response.value();
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* Creates request options for removeAdFromSet without sending the request
|
|
498
|
+
*/
|
|
499
|
+
async removeAdFromSetRequestOpts(requestParameters: RemoveAdFromSetRequest): Promise<runtime.RequestOpts> {
|
|
500
|
+
if (requestParameters['adsetId'] == null) {
|
|
501
|
+
throw new runtime.RequiredError(
|
|
502
|
+
'adsetId',
|
|
503
|
+
'Required parameter "adsetId" was null or undefined when calling removeAdFromSet().'
|
|
504
|
+
);
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
if (requestParameters['adId'] == null) {
|
|
508
|
+
throw new runtime.RequiredError(
|
|
509
|
+
'adId',
|
|
510
|
+
'Required parameter "adId" was null or undefined when calling removeAdFromSet().'
|
|
511
|
+
);
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
const queryParameters: any = {};
|
|
515
|
+
|
|
516
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
let urlPath = `/adsets/{adset_id}/ads/{ad_id}`;
|
|
520
|
+
urlPath = urlPath.replace(`{${"adset_id"}}`, encodeURIComponent(String(requestParameters['adsetId'])));
|
|
521
|
+
urlPath = urlPath.replace(`{${"ad_id"}}`, encodeURIComponent(String(requestParameters['adId'])));
|
|
522
|
+
|
|
523
|
+
return {
|
|
524
|
+
path: urlPath,
|
|
525
|
+
method: 'DELETE',
|
|
526
|
+
headers: headerParameters,
|
|
527
|
+
query: queryParameters,
|
|
528
|
+
};
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* Remove an ad from the set
|
|
533
|
+
*/
|
|
534
|
+
async removeAdFromSetRaw(requestParameters: RemoveAdFromSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>> {
|
|
535
|
+
const requestOptions = await this.removeAdFromSetRequestOpts(requestParameters);
|
|
536
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
537
|
+
|
|
538
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AdSetResponseFromJSON(jsonValue));
|
|
539
|
+
}
|
|
540
|
+
|
|
541
|
+
/**
|
|
542
|
+
* Remove an ad from the set
|
|
543
|
+
*/
|
|
544
|
+
async removeAdFromSet(requestParameters: RemoveAdFromSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse> {
|
|
545
|
+
const response = await this.removeAdFromSetRaw(requestParameters, initOverrides);
|
|
546
|
+
return await response.value();
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* Creates request options for updateAdSet without sending the request
|
|
551
|
+
*/
|
|
552
|
+
async updateAdSetRequestOpts(requestParameters: UpdateAdSetOperationRequest): Promise<runtime.RequestOpts> {
|
|
553
|
+
if (requestParameters['adsetId'] == null) {
|
|
554
|
+
throw new runtime.RequiredError(
|
|
555
|
+
'adsetId',
|
|
556
|
+
'Required parameter "adsetId" was null or undefined when calling updateAdSet().'
|
|
557
|
+
);
|
|
558
|
+
}
|
|
559
|
+
|
|
560
|
+
if (requestParameters['updateAdSetRequest'] == null) {
|
|
561
|
+
throw new runtime.RequiredError(
|
|
562
|
+
'updateAdSetRequest',
|
|
563
|
+
'Required parameter "updateAdSetRequest" was null or undefined when calling updateAdSet().'
|
|
564
|
+
);
|
|
565
|
+
}
|
|
566
|
+
|
|
567
|
+
const queryParameters: any = {};
|
|
568
|
+
|
|
569
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
570
|
+
|
|
571
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
let urlPath = `/adsets/{adset_id}`;
|
|
575
|
+
urlPath = urlPath.replace(`{${"adset_id"}}`, encodeURIComponent(String(requestParameters['adsetId'])));
|
|
576
|
+
|
|
577
|
+
return {
|
|
578
|
+
path: urlPath,
|
|
579
|
+
method: 'PUT',
|
|
580
|
+
headers: headerParameters,
|
|
581
|
+
query: queryParameters,
|
|
582
|
+
body: UpdateAdSetRequestToJSON(requestParameters['updateAdSetRequest']),
|
|
583
|
+
};
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Update an ad set
|
|
588
|
+
*/
|
|
589
|
+
async updateAdSetRaw(requestParameters: UpdateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdSetResponse>> {
|
|
590
|
+
const requestOptions = await this.updateAdSetRequestOpts(requestParameters);
|
|
591
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
592
|
+
|
|
593
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AdSetResponseFromJSON(jsonValue));
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* Update an ad set
|
|
598
|
+
*/
|
|
599
|
+
async updateAdSet(requestParameters: UpdateAdSetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdSetResponse> {
|
|
600
|
+
const response = await this.updateAdSetRaw(requestParameters, initOverrides);
|
|
601
|
+
return await response.value();
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
# AdSetResponse
|
|
3
|
+
|
|
4
|
+
Ad set information
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`campaignId` | string
|
|
12
|
+
`name` | string
|
|
13
|
+
`targeting` | [AdSetTargeting](AdSetTargeting.md)
|
|
14
|
+
`dailyBudget` | number
|
|
15
|
+
`adIds` | Array<string>
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`lastModifiedAt` | Date
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { AdSetResponse } from ''
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"campaignId": null,
|
|
28
|
+
"name": null,
|
|
29
|
+
"targeting": null,
|
|
30
|
+
"dailyBudget": null,
|
|
31
|
+
"adIds": null,
|
|
32
|
+
"createdAt": null,
|
|
33
|
+
"lastModifiedAt": null,
|
|
34
|
+
} satisfies AdSetResponse
|
|
35
|
+
|
|
36
|
+
console.log(example)
|
|
37
|
+
|
|
38
|
+
// Convert the instance to a JSON string
|
|
39
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
40
|
+
console.log(exampleJSON)
|
|
41
|
+
|
|
42
|
+
// Parse the JSON string back to an object
|
|
43
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdSetResponse
|
|
44
|
+
console.log(exampleParsed)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
48
|
+
|
|
49
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# AdSetTargeting
|
|
3
|
+
|
|
4
|
+
Targeting configuration for an ad set
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`zones` | Array<string>
|
|
11
|
+
`timeSlots` | Array<string>
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { AdSetTargeting } from ''
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"zones": null,
|
|
21
|
+
"timeSlots": null,
|
|
22
|
+
} satisfies AdSetTargeting
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdSetTargeting
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|