クーリエゴーダウンロード - クーリエゴーソースコードのダウンロード

Courier Go ライブラリ

これは、Courier REST API を使用して通知を送信するための公式 Go ライブラリです。

ドキュメント

リクエストとレスポンスのペイロードとプロパティの詳細については、公式 Courier API ドキュメントを参照してください。

要件

このモジュールには Go バージョン 1.13 以上が必要です。

インストール

次のコマンドを実行して、Go モジュールで Go ライブラリを使用します。

go get github.com/trycourier/courier-go/v3

インスタンス化

"), )">

 import (
  "context"
  "fmt"

  courierclient "github.com/trycourier/courier-go/v3/client"
  option "github.com/trycourier/courier-go/v3/option"
)

client := courierclient . NewClient (
  option . WithAuthorizationToken ( "" ),
)

使用法

"),
)
sendResponse, err := client.Send(
  context.TODO(),
  &courier.SendMessageRequest{
    Message: courier.NewMessageFromTemplateMessage({
      Template: "",
    }),
  },
)
if err != nil {
  return err
}
fmt.Printf("Sent message %sn", sendResponse.RequestId)"> import (
  "context"
  "fmt"

  courier "github.com/trycourier/courier-go/v3"
  courierclient "github.com/trycourier/courier-go/v3/client"
  option "github.com/trycourier/courier-go/v3/option"

)

client := courierclient . NewClient (
  option . WithAuthorizationToken ( "" ),
)
sendResponse , err := client . Send (
  context . TODO (),
  & courier. SendMessageRequest {
    Message : courier. NewMessageFromTemplateMessage ({
      Template : "" ,
    }),
  },
)
if err != nil {
  return err
}
fmt . Printf ( "Sent message %s n " , sendResponse . RequestId )

労働組合

私たちの API、特に send メソッドは、いくつかの共用体を使用します。 Go SDK は、以下に示すように、これらのcourier.Messageを構築するための structs を定義します。

 import (
  courier "github.com/trycourier/courier-go/v3"
)

request := & courier. SendMessageRequest {
  // Construct a content message.
  Message : & courier. Message {
    ContentMessage : & courier. ContentMessage {
      // Construct a single recepient that is a user recepient.
      To : & courier. MessageRecipient {
        Recipient : & courier. Recipient {
          UserRecipient : & courier. UserRecipient {
            Email : courier . String ( "[email protected]" ),
            Data : & courier. MessageData {
              "name" : "Marty" ,
            },
          },
        },
      },
      // Construct content from elemental content sugar.
      Content : & courier. Content {
        ElementalContentSugar : & courier. ElementalContentSugar {
          Title : "Back to the Future" ,
          Body :  "Oh my {{name}}, we need 1.21 Gigawatts!" ,
        },
      },
    },
  },
}

重大な変更 (3.0.7 -> 3.0.8)

3.0.8 では、より優れたユニオン構築エクスペリエンスを導入しました。たとえば、 courier.Messageタイプは以前は次のように構築されていました。

 import (
  courier "github.com/trycourier/courier-go/v3"
)

request := courier. SendMessageRequest {
  // Construct a content message.
  Message : courier . NewMessageFromContentMessage (
    & courier. ContentMessage {
      // Construct a single recepient that is a user recepient.
      To : courier . NewMessageRecipientFromRecipient (
        courier . NewRecipientFromUserRecipient (
          & courier. UserRecipient {
            Email : courier . String ( "[email protected]" ),
            Data : & courier. MessageData {
              "name" : "Marty" ,
            },
          },
        ),
      ),
      // Construct content from elemental content sugar.
      Content : courier . NewContentFromElementalContentSugar (
        & courier. ElementalContentSugar {
          Title : "Back to the Future" ,
          Body :  "Oh my {{name}}, we need 1.21 Gigawatts!" ,
        },
      ),
    },
  ),
}

構造はかなり似ていますが、古いアプローチでは、さまざまな面倒なコンストラクター関数名 (例: courier.NewContentFromElementalContentSugar ) をナビゲートする必要がありました。

新しいアプローチでは、これらのコンストラクターが完全に削除されるため、エクスペリエンスが大幅に簡素化されます。古いアプローチからの移行は、次のように具体的な型を適切なフィールドに設定するだけで簡単です。

前に

  ...
  Content : courier . NewContentFromElementalContentSugar (
    & courier. ElementalContentSugar {
      Title : "Back to the Future" ,
      Body :  "Oh my {{name}}, we need 1.21 Gigawatts!" ,
    },
  ),
  ...

後

  ...
  Content : & courier. Content {
    ElementalContentSugar : & courier. ElementalContentSugar {
      Title : "Back to the Future" ,
      Body :  "Oh my {{name}}, we need 1.21 Gigawatts!" ,
    },
  },
  ...

タイムアウト

個々のリクエストに対するタイムアウトの設定は、標準のcontextライブラリを使用するのと同じくらい簡単です。個々の API 呼び出しに 1 秒のタイムアウトを設定すると、次のようになります。

 ctx , cancel := context . WithTimeout ( context . TODO (), time . Second )
defer cancel ()

response , err := client . Send (
  ctx ,
  & courier. SendMessageRequest {
    Message : ...
  },
)

クライアントオプション

ライブラリの動作を調整するためのさまざまなクライアントオプションが含まれています。これには、リクエストごとに送信される認可トークンの構成や、インストルメントされた独自の*http.Clientの提供などが含まれます。これらのオプションの両方を以下に示します。

"), option.WithHTTPClient( &http.Client{ Timeout: 5 * time.Second, }, ), )">

 client := courierclient . NewClient (
  option . WithAuthorizationToken ( "" ),
  option . WithHTTPClient (
    & http. Client {
      Timeout : 5 * time . Second ,
    },
  ),
)

独自の*http.Clientを提供することをお勧めします。それ以外の場合は、 http.DefaultClientが使用され、クライアントは応答を無期限に待機します (リクエストごとのコンテキストベースのタイムアウトが使用されない限り)。

エラー

構造化エラータイプは、成功以外のステータスコードを返す API 呼び出しから返されます。たとえば、次のようにして、エラーが不正なリクエスト (ステータスコード 400) によるものかどうかを確認できます。

 response , err := client . Send (
  context . TODO (),
  & courier. SendMessageRequest {},
)
if err != nil {
  if apiErr , ok := err .( * core. APIError ); ok && apiErr . StatusCode == http . StatusBadRequest {
    // Do something with the bad request ...
  }
  return err
}

これらのエラーは、 errors.Isおよびerrors.As API とも互換性があるため、次のようにエラーにアクセスできます。

 response , err := client . Send (
  context . TODO (),
  & courier. SendMessageRequest {},
)
if err != nil {
  var apiErr * core. APIError
  if errors . As ( err , apiError ); ok {
    switch apiErr . StatusCode {
      case http . StatusBadRequest :
        // Do something with the bad request ...
    }
  }
  return err
}

追加情報でエラーをラップし、 errors.Isおよびerrors.Asを使用して型にアクセスする機能を保持したい場合は、 %wディレクティブを使用できます。

 response , err := client . Send (
  context . TODO (),
  & courier. SendMessageRequest {},
)
if err != nil {
  return fmt . Errorf ( "failed to list employees: %w" , err )
}

貢献する

私たちはこの SDK へのオープンソースの貢献を重視していますが、このライブラリはプログラムによって生成されています。このライブラリに直接行われた追加は、生成コードに移動する必要があります。そうしないと、次に生成されるリリースで上書きされてしまいます。概念実証として PR を自由に開いてください。ただし、そのままではマージできないことに注意してください。まずは問題を開いて話し合うことをお勧めします。

一方、README への貢献はいつでも大歓迎です。

拡大する