Merge pull request #141 from EasyPost/smartrate

official/docs/csharp/current/smartrate/retrieve-recommend-ship-date.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using EasyPost;
+using EasyPost.Models.API;
+using EasyPost.Parameters;
+
+namespace EasyPostExamples
+{
+    public class Examples
+    {
+        public static async Task Main()
+        {
+            var client = new EasyPost.Client(new EasyPost.ClientConfiguration("EASYPOST_API_KEY"));
+
+            Parameters.Shipment.RecommendShipDateForShipment parameters = new()
+            {
+                DesiredDeliveryDate = "2024-07-18",
+            };
+
+            List<RecommendShipDateForShipmentResult> rates = await client.Shipment.RecommendShipDate("shp_...", parameters);
+
+            Console.WriteLine(JsonConvert.SerializeObject(rates, Formatting.Indented));
+        }
+    }
+}

official/docs/csharp/current/smartrate/retrieve-standalone-smartrate-deliver-by.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using EasyPost;
+using EasyPost.Models.API;
+using EasyPost.Parameters;
+
+namespace EasyPostExamples
+{
+    public class Examples
+    {
+        public static async Task Main()
+        {
+            var client = new EasyPost.Client(new EasyPost.ClientConfiguration("EASYPOST_API_KEY"));
+
+            Parameters.SmartRate.EstimateDeliveryDateForZipPair estimateDeliveryDateForZipPairParameters = new()
+            {
+                OriginPostalCode = address1Parameters.Zip,
+                DestinationPostalCode = address2Parameters.Zip,
+                PlannedShipDate = Fixtures.PlannedShipDate,
+                Carriers = ["USPS"],
+            };
+
+            EstimateDeliveryDateForZipPairResult results = await client.SmartRate.EstimateDeliveryDate(estimateDeliveryDateForZipPairParameters);
+
+            Console.WriteLine(JsonConvert.SerializeObject(results, Formatting.Indented));
+        }
+    }
+}

official/docs/csharp/current/smartrate/retrieve-standalone-smartrate-deliver-on.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using EasyPost;
+using EasyPost.Models.API;
+using EasyPost.Parameters;
+
+namespace EasyPostExamples
+{
+    public class Examples
+    {
+        public static async Task Main()
+        {
+            var client = new EasyPost.Client(new EasyPost.ClientConfiguration("EASYPOST_API_KEY"));
+
+            Parameters.SmartRate.RecommendShipDateForZipPair recommendShipDateForZipPairParameters = new()
+            {
+                OriginPostalCode = address1Parameters.Zip,
+                DestinationPostalCode = address2Parameters.Zip,
+                DesiredDeliveryDate = Fixtures.DesiredDeliveryDate,
+                Carriers = ["USPS"],
+            };
+
+            RecommendShipDateForZipPairResult results = await client.SmartRate.RecommendShipDate(recommendShipDateForZipPairParameters);
+
+            Console.WriteLine(JsonConvert.SerializeObject(results, Formatting.Indented));
+        }
+    }
+}

official/docs/curl/current/smartrate/retrieve-recommend-ship-date.sh

@@ -0,0 +1,2 @@
+curl -X GET https://api.easypost.com/v2/shipments/shp_.../smartrate/precision_shipping?desired_delivery_date=yyyy-mm-dd \
+  -u "EASYPOST_API_KEY":

official/docs/curl/current/smartrate/retrieve-standalone-smartrate-deliver-by.sh

@@ -0,0 +1,9 @@
+curl -X POST https://api.easypost.com/v2/smartrate/deliver_by \
+  -u "EASYPOST_API_KEY": \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "from_zip": "10001",
+    "planned_ship_date": "2024-07-18",
+    "to_zip": "10002",
+    "carriers": [UPS],
+  }'

official/docs/curl/current/smartrate/retrieve-standalone-smartrate-deliver-on.sh

@@ -0,0 +1,9 @@
+curl -X POST https://api.easypost.com/v2/smartrate/deliver_on \
+  -u "EASYPOST_API_KEY": \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "from_zip": "10001",
+    "desired_delivery_date": "2024-07-18",
+    "to_zip": "10002",
+    "carriers": [UPS],
+  }'

official/docs/golang/current/carrier-accounts/create.go

@@ -28,5 +28,14 @@ func main() {
 		},
 	)
 
+	// For UPS account creation, please use below method instead
+
+	createUpsParameters := &easypost.UpsCarrierAccountCreationParameters{
+		AccountNumber: "123456789",
+		Type:          "UpsAccount",
+	}
+
+	carrierAccount, err := client.CreateUpsCarrierAccount(createUpsParameters)
+
 	fmt.Println(carrierAccount)
 }

official/docs/golang/current/carrier-accounts/update.go

@@ -19,5 +19,13 @@ func main() {
 		},
 	)
 
+	// For UPS account update, please use below method instead
+
+	updateParameters := &easypost.UpsCarrierAccountUpdateParameters{
+		AccountNumber: "987654321",
+	}
+
+	carrierAccount, err := client.UpdateUpsCarrierAccount(carrierAccount.ID, updateParameters)
+
 	fmt.Println(carrierAccount)
 }

official/docs/golang/current/smartrate/retrieve-recommend-ship-date.go

@@ -0,0 +1,15 @@
+package example
+
+import (
+	"fmt"
+
+	"github.com/EasyPost/easypost-go/v4"
+)
+
+func main() {
+	client := easypost.New("EASYPOST_API_KEY")
+
+	rates, _ := client.RecommendShipDateForShipment("shp_...", "YYYY-MM-DD")
+
+	fmt.Println(rates)
+}

official/docs/golang/current/smartrate/retrieve-standalone-smartrate-deliver-by.go

@@ -0,0 +1,22 @@
+package example
+
+import (
+	"fmt"
+
+	"github.com/EasyPost/easypost-go/v4"
+)
+
+func main() {
+	client := easypost.New("EASYPOST_API_KEY")
+
+	params := &easypost.EstimateDeliveryDateForZipPairParams{
+		OriginPostalCode:      "10001",
+		DestinationPostalCode: "10002",
+		Carriers:              []string{"UPS", "FedEx"},
+		PlannedShipDate:       "2024-07-18",
+	}
+
+	estimates, _ := client.EstimateDeliveryDateForZipPair(params)
+
+	fmt.Println(estimates)
+}

official/docs/golang/current/smartrate/retrieve-standalone-smartrate-deliver-on.go

@@ -0,0 +1,22 @@
+package example
+
+import (
+	"fmt"
+
+	"github.com/EasyPost/easypost-go/v4"
+)
+
+func main() {
+	client := easypost.New("EASYPOST_API_KEY")
+
+	params := &easypost.RecommendShipDateForZipPairParams{
+		OriginPostalCode:      "10001",
+		DestinationPostalCode: "10002",
+		Carriers:              []string{"UPS", "FedEx"},
+		DesiredDeliveryDate:   "2024-07-18",
+	}
+
+	recommendations, _ := client.RecommendShipDateForZipPair(params)
+
+	fmt.Println(recommendations)
+}

official/docs/java/current/smartrate/retrieve-recommend-ship-date.java

@@ -0,0 +1,20 @@
+package shipments;
+
+import com.easypost.exception.EasyPostException;
+import com.easypost.model.Shipment;
+import com.easypost.model.RecommendShipDateForShipmentResult;
+import com.easypost.service.EasyPostClient;
+
+import java.util.List;
+
+public class RetrieveRecommendShipDate {
+    public static void main(String[] args) throws EasyPostException {
+        EasyPostClient client = new EasyPostClient("EASYPOST_API_KEY");
+
+        Shipment shipment = client.shipment.retrieve("shp_...");
+        List<RecommendShipDateForShipmentResult> rates = client.shipment
+                .recommendShipDate(shipment.getId(), "YYYY-MM-DD");
+
+        System.out.println(rates);
+    }
+}

official/docs/java/current/smartrate/retrieve-standalone-smartrate-deliver-by.java

@@ -0,0 +1,25 @@
+package shipments;
+
+import com.easypost.exception.EasyPostException;
+import com.easypost.model.EstimateDeliveryDateForZipPairResult;
+import com.easypost.service.EasyPostClient;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+public class RetrieveRecommendShipDate {
+    public static void main(String[] args) throws EasyPostException {
+        EasyPostClient client = new EasyPostClient("EASYPOST_API_KEY");
+        Map<String, Object> params = new HashMap<String, Object>();
+        params.put("from_zip", "10001");
+        params.put("to_zip", "10002");
+        params.put("planned_ship_date", "2024-07-18");
+        params.put("carriers", Collections.singletonList("UPS"));
+
+        EstimateDeliveryDateForZipPairResult results = client.smartRate
+                .estimateDeliveryDate(params);
+
+        System.out.println(results);
+    }
+}

official/docs/java/current/smartrate/retrieve-standalone-smartrate-deliver-on.java

@@ -0,0 +1,25 @@
+package shipments;
+
+import com.easypost.exception.EasyPostException;
+import com.easypost.model.RecommendShipDateForZipPairResult;
+import com.easypost.service.EasyPostClient;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+public class RetrieveRecommendShipDate {
+    public static void main(String[] args) throws EasyPostException {
+        EasyPostClient client = new EasyPostClient("EASYPOST_API_KEY");
+        Map<String, Object> params = new HashMap<String, Object>();
+        params.put("from_zip", "10001");
+        params.put("to_zip", "10002");
+        params.put("desired_delivery_date", "2024-07-18");
+        params.put("carriers", Collections.singletonList("UPS"));
+
+        RecommendShipDateForZipPairResult results = client.smartRate
+                .recommendShipDate(params);
+
+        System.out.println(results);
+    }
+}

official/docs/node/current/smartrate/retrieve-recommend-ship-date.js

@@ -0,0 +1,9 @@
+const EasyPostClient = require('@easypost/api');
+
+const client = new EasyPostClient('EASYPOST_API_KEY');
+
+(async () => {
+  const rates = await client.Shipment.recommendShipDate('shp_...', 'YYYY-MM-DD');
+
+  console.log(rates);
+})();

official/docs/node/current/smartrate/retrieve-standalone-smartrate-deliver-by.js

@@ -0,0 +1,16 @@
+const EasyPostClient = require('@easypost/api');
+
+const client = new EasyPostClient('EASYPOST_API_KEY');
+
+const params = {
+  from_zip: '10001',
+  to_zip: '10002',
+  planned_ship_date: '2024-07-18',
+  carriers: ['UPS'],
+};
+
+(async () => {
+  const results = await client.SmartRate.estimateDeliveryDate(params);
+
+  console.log(results);
+})();

official/docs/node/current/smartrate/retrieve-standalone-smartrate-deliver-on.js

@@ -0,0 +1,16 @@
+const EasyPostClient = require('@easypost/api');
+
+const client = new EasyPostClient('EASYPOST_API_KEY');
+
+const params = {
+  from_zip: '10001',
+  to_zip: '10002',
+  desired_delivery_date: '2024-07-18',
+  carriers: ['UPS'],
+};
+
+(async () => {
+  const results = await client.SmartRate.recommendShipDate(params);
+
+  console.log(results);
+})();

official/docs/php/current/smartrate/retrieve-recommend-ship-date.php

@@ -0,0 +1,7 @@
+<?php
+
+$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
+
+$rates = $client->shipment->recommendShipDate('shp_...', 'YYYY-MM-DD');
+
+echo $rates;

official/docs/php/current/smartrate/retrieve-standalone-smartrate-deliver-by.php

@@ -0,0 +1,14 @@
+<?php
+
+$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
+
+$params = [
+    'from_zip' => '10001',
+    'to_zip' => '10002',
+    'planned_ship_date' => '2024-07-18',
+    'carriers' => ['UPS'],
+];
+
+$results = $client->smartRate->estimateDeliveryDate($params);
+
+echo $results;

official/docs/php/current/smartrate/retrieve-standalone-smartrate-deliver-on.php

@@ -0,0 +1,14 @@
+<?php
+
+$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
+
+$params = [
+    'from_zip' => '10001',
+    'to_zip' => '10002',
+    'desired_delivery_date' => '2024-07-18',
+    'carriers' => ['UPS'],
+];
+
+$results = $client->smartRate->recommendShipDate($params);
+
+echo $results;

official/docs/python/current/smartrate/retrieve-recommend-ship-date.py

@@ -0,0 +1,10 @@
+import easypost
+
+client = easypost.EasyPostClient("EASYPOST_API_KEY")
+
+estimated_delivery_dates = client.shipment.recommend_ship_date(
+    "shp_...",
+    desired_delivery_date="YYYY-MM-DD",
+)
+
+print(estimated_delivery_dates)

official/docs/python/current/smartrate/retrieve-standalone-smartrate-deliver-by.py

@@ -0,0 +1,14 @@
+import easypost
+
+client = easypost.EasyPostClient("EASYPOST_API_KEY")
+
+params = {
+    "from_zip": "10001",
+    "to_zip": "10002",
+    "planned_ship_date": "2024-07-18",
+    "carriers": ["usps"],
+}
+
+results = client.smartrate.estimate_delivery_date(**params)
+
+print(results)

official/docs/python/current/smartrate/retrieve-standalone-smartrate-deliver-on.py

@@ -0,0 +1,14 @@
+import easypost
+
+client = easypost.EasyPostClient("EASYPOST_API_KEY")
+
+params = {
+    "from_zip": "10001",
+    "to_zip": "10002",
+    "desired_delivery_date": "2024-07-18",
+    "carriers": ["usps"],
+}
+
+results = client.smartrate.recommend_ship_date(**params)
+
+print(results)