diff --git a/generators/assets/cli/en.yaml b/generators/assets/cli/en.yaml index dc8d6094..465c1a06 100644 --- a/generators/assets/cli/en.yaml +++ b/generators/assets/cli/en.yaml @@ -3,6 +3,9 @@ cli: audit-logs: summary: Retrieve audit logs. description: Retrieve audit logs. + api: + summary: Retrieve audit logs for API. + description: Retrieve audit logs for API. napter: summary: Retrieve audit logs for Napter. description: Retrieve audit logs for Napter. @@ -12,6 +15,9 @@ cli: bills: summary: Show or export billing info. description: Show billing info for specified period, or export the billing info to a file + summaries: + summary: Get summarized billing information. + description: Get summarized billing information. cell-locations: summary: Retrieves cell tower location information. description: Retrieves cell tower location information. @@ -34,6 +40,7 @@ cli: configure: summary: Show, create or update configurations (profiles). description: Show, create or update configurations (profiles). + overwrite: Overwrites profile information even if it already exists. profile: permission_is_too_open: "Permissions for the file '%s' which contains your credentials are too open.\nIt is required that your credential files are NOT accessible by others." prompt: "--- SORACOM CLI setup ---\nThis will create a directory %s if it does not exist yet and place '%s.json' in it." @@ -172,9 +179,15 @@ cli: auth-keys: summary: List, create or delete operator's AuthKeys. description: List, create or delete operator's AuthKeys. + configuration: + summary: List, create or delete operator's configuration. + description: List, create or delete operator's configuration. orders: summary: List, create or cancel orders. description: List, create or cancel orders. + resource-initial-setting: + summary: Manage initial settings for ordered products. + description: Manage initial settings for ordered products. payer-information: summary: Get or edit payer information. description: Get or edit payer information. @@ -254,12 +267,21 @@ cli: devices: summary: Manage SoraCam devices. description: Manage SoraCam devices. + atomcam: + summary: Performs operations specific to the ATOM Cam series camera devices. + description: Performs operations specific to the ATOM Cam series camera devices. + settings: + summary: Manage settings specific to the ATOM Cam series camera devices. + description: Manage settings specific to the ATOM Cam series camera devices. events: summary: Retrieve event history for SoraCam devices. description: Retrieve event history for SoraCam devices. images: summary: Manage image exports from SoraCam devices. description: Manage image exports from SoraCam devices. + recordings-and-events: + summary: Obtains recording status of cloud continuous recording and event occurrences for SoraCam devices. + description: Obtains recording status of cloud continuous recording and event occurrences for SoraCam devices. videos: summary: Manage video exports from SoraCam devices. description: Manage video exports from SoraCam devices. @@ -272,15 +294,33 @@ cli: air: summary: Show or export Air statistics. description: Show or export Air statistics. + groups: + summary: Get data usage history aggregating all IoT SIMs belonging to the specified group. + description: Get data volume history aggregating all IoT SIMs belonging to the specified group. + operators: + summary: Get data usage history aggregated across all IoT SIMs owned by the specified operator. + description: Get data usage history aggregated across all IoT SIMs owned by the specified operator. sims: summary: Show or export Air statistics by SIM ID. description: Show or export Air statistics by SIM ID. beam: summary: Show or export Beam statistics. description: Show or export Beam statistics. + funk: + summary: Perform operations related to SORACOM Funk usage history. + description: Perform operations related to SORACOM Funk usage history. + funnel: + summary: Perform operations related to SORACOM Funnel usage history. + description: Perform operations related to SORACOM Funnel usage history. harvest: summary: Get usage report for Harvest. description: Get usage report for Harvest. + operators: + summary: Perform per-operator operations on SORACOM Harvest Data usage statistics. + description: Perform per-operator operations on SORACOM Harvest Data usage statistics. + subscribers: + summary: Get SORACOM Harvest Data usage history for the subscriber specified by IMSI. + description: Get SORACOM Harvest Data usage history for the subscriber specified by IMSI. napter: summary: Get usage report for Napter. description: Get usage report for Napter. diff --git a/generators/assets/cli/ja.yaml b/generators/assets/cli/ja.yaml index 07965bd5..1e493cb9 100644 --- a/generators/assets/cli/ja.yaml +++ b/generators/assets/cli/ja.yaml @@ -3,6 +3,9 @@ cli: audit-logs: summary: 監査ログを取得します。 description: 監査ログを取得します。 + api: + summary: API の監査ログを取得します。 + description: API の監査ログを取得します。 napter: summary: Napter の監査ログを取得します。 description: Napter の監査ログを取得します。 @@ -12,6 +15,9 @@ cli: bills: summary: 課金に関する情報を確認したりファイルへのエクスポートを行います。 description: 課金に関する情報を確認したりファイルへのエクスポートを行います。 + summaries: + summary: 要約された課金情報を取得します。 + description: 要約された課金情報を取得します。 cell-locations: summary: 基地局の位置情報を取得します。 description: 基地局の位置情報を取得します。 @@ -32,8 +38,9 @@ cli: summary: zsh 用の補完 (completion) スクリプトを生成します。 description: zsh 用の補完 (completion) スクリプトを生成します。 configure: - summary: コマンド実行環境（プロファイル）の設定や表示を行います。 - description: コマンド実行環境（プロファイル）の設定や表示を行います。 + summary: コマンド実行環境 (プロファイル) の設定や表示を行います。 + description: コマンド実行環境 (プロファイル) の設定や表示を行います。 + overwrite: プロファイル情報がすでに存在していても上書きします。 profile: permission_is_too_open: "認証情報ファイル %s へのアクセス権が十分に絞り込まれていません。\n認証情報ファイルへは、soracom コマンドを実行しているユーザーのみがアクセス可能なように設定する必要があります。" prompt: "--- SORACOM CLI セットアップ ---\n%s ディレクトリがなければ作成し、そこにファイル '%s.json' を作成します。" @@ -45,9 +52,9 @@ cli: 認証方法を選択してください。 - 1. AuthKeyId と AuthKey を入力する（推奨） + 1. AuthKeyId と AuthKey を入力する (推奨) 2. オペレーターのメールアドレスとパスワードを入力する - 3. SAM ユーザーの認証情報を入力する（オペレーターID、ユーザー名、パスワード） + 3. SAM ユーザーの認証情報を入力する (オペレーターID、ユーザー名、パスワード) 4. スイッチユーザー select: "選択してください (1-4) > " @@ -59,10 +66,10 @@ cli: summary: プロファイル情報を表示します。 description: プロファイル情報を表示します。 configure_sandbox: - summary: API Sandbox 用のコマンド実行環境（プロファイル）の設定を行います。 - description: API Sandbox 用のコマンド実行環境（プロファイル）の設定を行います。 - auth_key: 本番環境のアカウントの AuthKey（本番環境のアカウントを持っているかどうかを確認するために使われます） - auth_key_id: 本番環境のアカウントの AuthKeyId（本番環境のアカウントを持っているかどうかを確認するために使われます） + summary: API Sandbox 用のコマンド実行環境 (プロファイル) の設定を行います。 + description: API Sandbox 用のコマンド実行環境 (プロファイル) の設定を行います。 + auth_key: 本番環境のアカウントの AuthKey (本番環境のアカウントを持っているかどうかを確認するために使われます) + auth_key_id: 本番環境のアカウントの AuthKeyId (本番環境のアカウントを持っているかどうかを確認するために使われます) email: API Sandbox 環境に作られるユーザーのメールアドレス overwrite: プロファイルが既に存在する場合、それを上書きするかどうかを指定します。 password: API Sandbox 環境に作られるユーザーのパスワード @@ -125,7 +132,7 @@ cli: coverage-type: | カバレッジタイプを指定します。グローバルカバレッジは 'g'、日本カバレッジは 'jp' です。 no-retry-on-error: | - このフラグを指定すると、API がエラーを返してきた場合にもリトライしません（デフォルトではバックオフしながら数回リトライします）。 + このフラグを指定すると、API がエラーを返してきた場合にもリトライしません (デフォルトではバックオフしながら数回リトライします)。 profile: | プロファイル名を指定します。 profile-command: | @@ -134,7 +141,7 @@ cli: すなわち事前に 'soracom configure' コマンドを実行しておく必要がなくなります。 認証情報をパスワードマネージャーなどのより安全な場所に格納しておき、外部コマンド経由でそれを利用することができます。 raw-output: | - API から返却されたレスポンスを加工せずにそのまま出力します（デフォルトでは JSON をインデントして表示します）。 + API から返却されたレスポンスを加工せずにそのまま出力します (デフォルトでは JSON をインデントして表示します)。 groups: summary: グループに関する操作を行います。 description: グループに関する操作を行います。 @@ -172,9 +179,15 @@ cli: auth-keys: summary: オペレーターの認証キーに関する操作を行います。 description: オペレーターの認証キーに関する操作を行います。 + configuration: + summary: オペレーター全体に関わるコンフィグレーションに関する操作を行います。 + description: オペレーター全体に関わるコンフィグレーションに関する操作を行います。 orders: summary: 商品の注文に関する操作を行います。 description: 商品の注文に関する操作を行います。 + resource-initial-setting: + summary: 発注した商品に対する初期設定を管理する + description: 発注した商品に対する初期設定を管理します。 payer-information: summary: 課金明細に出力する支払い者情報を取得または設定します。 description: 課金明細に出力する支払い者情報を取得または設定します。 @@ -197,8 +210,8 @@ cli: summary: 商品一覧を取得します。 description: 商品一覧を取得します。 query: - summary: リソース（サブスクライバー、Sigfox デバイス）をいろいろな条件で検索します。 - description: いろいろな条件を指定して、その条件に適合するリソース（サブスクライバー、Sigfox デバイス）を抽出します。 + summary: リソース (サブスクライバー、Sigfox デバイス) をいろいろな条件で検索します。 + description: いろいろな条件を指定して、その条件に適合するリソース (サブスクライバー、Sigfox デバイス) を抽出します。 refer-api-reference: このコマンドの引数およびレスポンスについての詳細は、https://users.soracom.io/ja-jp/tools/api/reference/#/%s/%s を参照してください。 resource-summaries: summary: リソースの要約を取得します。 @@ -231,38 +244,65 @@ cli: summary: Soracom Cloud Camera Services のライセンスパックに関する操作を行います。 description: Soracom Cloud Camera Services のライセンスパックに関する操作を行います。 devices: - summary: ソラカメ対応カメラデバイスに関する操作を行います。 - description: ソラカメ対応カメラデバイスに関する操作を行います。 + summary: ソラカメ対応カメラに関する操作を行います。 + description: ソラカメ対応カメラに関する操作を行います。 + atomcam: + summary: ATOM Cam シリーズのソラカメ対応カメラに固有の操作をする + description: ATOM Cam シリーズのソラカメ対応カメラに固有の操作を行います。 + settings: + summary: ATOM Cam シリーズのソラカメ対応カメラに固有の設定を管理します。 + description: ATOM Cam シリーズのソラカメ対応カメラに固有の設定を管理します。 events: - summary: ソラカメ対応カメラデバイスで検出されたイベントの一覧を取得します。 - description: ソラカメ対応カメラデバイスで検出されたイベントの一覧を取得します。 + summary: ソラカメ対応カメラで検出されたイベントの一覧を取得します。 + description: ソラカメ対応カメラで検出されたイベントの一覧を取得します。 images: - summary: ソラカメ対応カメラデバイスからの静止画のエクスポートに関する操作を行います。 - description: ソラカメ対応カメラデバイスからの静止画のエクスポートに関する操作を行います。 + summary: ソラカメ対応カメラからの静止画のエクスポートに関する操作を行います。 + description: ソラカメ対応カメラからの静止画のエクスポートに関する操作を行います。 + recordings-and-events: + summary: ソラカメ対応カメラのクラウド常時録画の録画状況とイベント発生日時の情報を合わせて取得する + description: ソラカメ対応カメラのクラウド常時録画の録画状況とイベント発生日時の情報を合わせて取得します。 videos: - summary: ソラカメ対応カメラデバイスからの動画のエクスポートに関する操作を行います。 - description: ソラカメ対応カメラデバイスからの動画のエクスポートに関する操作を行います。 + summary: ソラカメ対応カメラからの動画のエクスポートに関する操作を行います。 + description: ソラカメ対応カメラからの動画のエクスポートに関する操作を行います。 soralets: summary: Orbit の Soralet に関する操作を行います。 description: Orbit の Soralet に関する操作を行います。 stats: - summary: 統計情報に関する操作を行います。 - description: 統計情報に関する操作を行います。 + summary: 統計情報 (利用量履歴) に関する操作をする + description: 統計情報 (利用量履歴) に関する操作を行います。 air: - summary: Air の統計情報に関する操作を行います。 - description: Air の統計情報に関する操作を行います。 + summary: SORACOM Air の通信量履歴に関する操作をする + description: SORACOM Air の通信量履歴に関する操作をします。 + groups: + summary: 指定したグループに所属するすべての IoT SIM を集約したデータ通信量履歴を取得する + description: 指定したグループに所属するすべての IoT SIM を集約したデータ通信量履歴を取得します。 + operators: + summary: 指定したオペレーターが保有するすべての IoT SIM を集約したデータ通信量履歴を取得する + description: 指定したオペレーターが保有するすべての IoT SIM を集約したデータ通信量履歴を取得します。 sims: - summary: SIM ID で Air の統計情報に関する操作を行います。 - description: SIM ID で Air の統計情報に関する操作を行います。 + summary: SIM ID で指定した IoT SIM の通信量履歴を取得する + description: SIM ID で指定した IoT SIM の通信量履歴を取得します。 beam: - summary: Beam の統計情報に関する操作を行います。 - description: Beam の統計情報に関する操作を行います。 + summary: SORACOM Beam の利用量履歴に関する操作をする + description: SORACOM Beam の利用量履歴に関する操作をします。 + funk: + summary: SORACOM Funk の利用量履歴に関する操作をする + description: SORACOM Funk の利用量履歴に関する操作をします。 + funnel: + summary: SORACOM Funnel の利用量履歴に関する操作をする + description: SORACOM Funk の利用量履歴に関する操作をします。 harvest: - summary: Harvest の利用統計情報を取得します。 - description: Harvest の利用統計情報を取得します。 + summary: SORACOM Harvest の利用統計情報に関する操作をする + description: SORACOM Harvest の利用統計情報に関する操作をします。 + operators: + summary: オペレーター単位の SORACOM Harvest Data 利用統計情報に関する操作をする + description: オペレーター単位の SORACOM Harvest Data 利用統計情報に関する操作をします。 + subscribers: + summary: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得する + description: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得します。 napter: - summary: Napter の利用統計情報を取得します。 - description: Napter の利用統計情報を取得します。 + summary: SORACOM Napter の利用統計情報を取得する。 + description: SORACOM Napter の利用統計情報を取得します。 audit-logs: summary: Napter 監査ログの利用統計情報を取得します。 description: Napter 監査ログの利用統計情報を取得します。 @@ -279,8 +319,8 @@ cli: summary: 常に 500 Internal server error を返す API を呼び、リトライ処理が期待通りに動作するかどうかを確認します。 description: 常に 500 Internal server error を返す API を呼び、リトライ処理が期待通りに動作するかどうかを確認します。環境変数 SORACOM_VERBOSE=1 を指定した状態で実行するとよいでしょう。 unconfigure: - summary: コマンド実行環境（プロファイル）を削除します。 - description: コマンド実行環境（プロファイル）を削除します。 + summary: コマンド実行環境 (プロファイル) を削除します。 + description: コマンド実行環境 (プロファイル) を削除します。 prompt: "プロファイル %s を削除します。よろしいですか？ (y/N) " users: summary: SAM ユーザーに関する操作を行います。 @@ -307,8 +347,8 @@ cli: summary: バージョン情報を表示します。 description: バージョン情報を表示します。 volume-discounts: - summary: ボリュームディスカウント（長期利用割引）に関する操作を行います。 - description: ボリュームディスカウント（長期利用割引）に関する操作を行います。 + summary: ボリュームディスカウント (長期利用割引) に関する操作を行います。 + description: ボリュームディスカウント (長期利用割引) に関する操作を行います。 vpg: summary: VPG に関する操作を行います。 description: VPG (Virtual Private Gateways) に関する操作を行います。 diff --git a/generators/assets/sandbox/soracom-sandbox-api.en.yaml b/generators/assets/sandbox/soracom-sandbox-api.en.yaml index 85b4833b..cdd8b77b 100644 --- a/generators/assets/sandbox/soracom-sandbox-api.en.yaml +++ b/generators/assets/sandbox/soracom-sandbox-api.en.yaml @@ -2,26 +2,12 @@ openapi: 3.0.0 info: description: SORACOM SANDBOX API v1 title: SORACOM SANDBOX API - version: 20230507-231147 + version: 20230923-005714 servers: - - url: 'https://api-sandbox.soracom.io/v1' +- url: https://api-sandbox.soracom.io/v1 paths: /sandbox/coupons/create: post: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxCreateCouponResponse' - description: OK - '400': - description: Request is not correct. - security: - - api_key: [] - api_token: [] - tags: - - Coupon description: Creates a coupon. operationId: sandboxCreateCoupon requestBody: @@ -31,29 +17,31 @@ paths: $ref: '#/components/schemas/sandboxCreateCouponRequest' description: request required: true - summary: Creates a coupon - x-soracom-cli: - - sandbox coupons create - /sandbox/init: - post: responses: - '201': + "200": content: application/json: schema: - $ref: '#/components/schemas/sandboxAuthResponse' - description: Successfully created a sandbox operator. - '400': - description: 'Email address, AuthKeyId, or AuthKey is not correct.' + $ref: '#/components/schemas/sandboxCreateCouponResponse' + description: OK + "400": + description: Request is not correct. + security: + - api_key: [] + api_token: [] + summary: Creates a coupon tags: - - Operator - description: >- - Performs complex signup process at once, including registering dummy - payment method. Specify `email` and `password` for an operator which - will be created on sandbox, `authKeyId` and `authKey` for a real - operator on the production environment. An API Key and an API Token will - be included in the response if successful. Use the API Key and the API - Token to requests afterwards. + - 'API Sandbox: Coupon' + x-soracom-cli: + - sandbox coupons create + /sandbox/init: + post: + description: Performs complex signup process at once, including registering + dummy payment method. Specify `email` and `password` for an operator which + will be created on sandbox, `authKeyId` and `authKey` for a real operator + on the production environment. An API Key and an API Token will be included + in the response if successful. Use the API Key and the API Token to requests + afterwards. operationId: sandboxInitializeOperator requestBody: content: @@ -62,82 +50,81 @@ paths: $ref: '#/components/schemas/sandboxInitRequest' description: request required: true - summary: Creates an operator account. - x-soracom-cli: - - sandbox init - '/sandbox/operators/token/{email}': - post: - parameters: - - description: email - in: path - name: email - required: true - schema: - type: string responses: - '200': + "201": content: application/json: schema: - $ref: '#/components/schemas/sandboxGetSignupTokenResponse' - description: Successfully retrieved signup token. - '400': - description: 'Email address, AuthKeyId, or AuthKey is not correct.' + $ref: '#/components/schemas/sandboxAuthResponse' + description: Successfully created a sandbox operator. + "400": + description: Email address, AuthKeyId, or AuthKey is not correct. + summary: Creates an operator account tags: - - Operator - description: >- - Retrieves a 'signup token' for registration confirmation. Please specify - a pair of AuthKeyId and AuthKey of a SAM user on the production - environment to check if the caller has a valid account on it. - operationId: sandboxGetSignupToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxGetSignupTokenRequest' - description: Authentication request - required: true - summary: Gets a signup token + - 'API Sandbox: Operator' x-soracom-cli: - - sandbox operators get-signup-token - '/sandbox/operators/{operator_id}': + - sandbox init + /sandbox/operators/{operator_id}: delete: + description: Deletes the specified operator. + operationId: sandboxDeleteOperator parameters: - - description: Operator ID - in: path - name: operator_id - required: true - schema: - type: string + - description: Operator ID + in: path + name: operator_id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '400': + "400": description: Operator does not exist. security: - - api_key: [] - api_token: [] - tags: - - Operator - description: Deletes the specified operator. - operationId: sandboxDeleteOperator + - api_key: [] + api_token: [] summary: Deletes an operator + tags: + - 'API Sandbox: Operator' x-soracom-cli: - - sandbox operators delete - /sandbox/orders/ship: + - sandbox operators delete + /sandbox/operators/token/{email}: post: + description: Retrieves a 'signup token' for registration confirmation. Please + specify a pair of AuthKeyId and AuthKey of a SAM user on the production environment + to check if the caller has a valid account on it. + operationId: sandboxGetSignupToken + parameters: + - description: Email + in: path + name: email + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxGetSignupTokenRequest' + description: Authentication request. + required: true responses: - '200': - description: OK - '400': - description: Order does not exist. - security: - - api_key: [] - api_token: [] + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxGetSignupTokenResponse' + description: Successfully retrieved signup token. + "400": + description: Email address, AuthKeyId, or AuthKey is not correct. + summary: Gets a signup token tags: - - Order - description: >- - Changes the shipping status to 'shipped' and gets ready the subscribers + - 'API Sandbox: Operator' + x-soracom-cli: + - sandbox operators get-signup-token + /sandbox/orders/ship: + post: + description: Changes the shipping status to 'shipped' and gets ready the subscribers included in the order. operationId: sandboxShipOrder requestBody: @@ -147,33 +134,32 @@ paths: $ref: '#/components/schemas/sandboxShipOrderRequest' description: Shipping request required: true - summary: Ships the specified order. - x-soracom-cli: - - sandbox orders ship - '/sandbox/stats/air/subscribers/{imsi}': - post: - parameters: - - description: IMSI - in: path - name: imsi - required: true - schema: - type: string responses: - '200': + "200": description: OK - '400': - description: Data with the same timestamp already exists. + "400": + description: Order does not exist. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Ships the specified order tags: - - Stats - description: >- - Populates Air stats for testing purpose. Inserted data are going to be - automatically accumulated. It is not possible to put the data multiple + - 'API Sandbox: Order' + x-soracom-cli: + - sandbox orders ship + /sandbox/stats/air/subscribers/{imsi}: + post: + description: Populates Air stats for testing purpose. Inserted data are going + to be automatically accumulated. It is not possible to put the data multiple times with the same timestamp. operationId: sandboxInsertAirStats + parameters: + - description: IMSI. + in: path + name: imsi + required: true + schema: + type: string requestBody: content: application/json: @@ -181,33 +167,32 @@ paths: $ref: '#/components/schemas/sandboxInsertAirStatsRequest' description: The Air stats (up/down bytes of data) with specified timestamp. required: true - summary: Inserts Air stats for testing - x-soracom-cli: - - sandbox stats air insert - '/sandbox/stats/beam/subscribers/{imsi}': - post: - parameters: - - description: IMSI - in: path - name: imsi - required: true - schema: - type: string responses: - '200': + "200": description: OK - '400': + "400": description: Data with the same timestamp already exists. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Inserts Air stats for testing tags: - - Stats - description: >- - Populates Beam stats for testing purpose. Inserted data are going to be - automatically accumulated. It is not possible to put the data multiple + - 'API Sandbox: Stats' + x-soracom-cli: + - sandbox stats air insert + /sandbox/stats/beam/subscribers/{imsi}: + post: + description: Populates Beam stats for testing purpose. Inserted data are going + to be automatically accumulated. It is not possible to put the data multiple times with the same timestamp. operationId: sandboxInsertBeamStats + parameters: + - description: IMSI. + in: path + name: imsi + required: true + schema: + type: string requestBody: content: application/json: @@ -215,43 +200,53 @@ paths: $ref: '#/components/schemas/sandboxInsertBeamStatsRequest' description: The Beam stats (number of requests) with specified timestamp. required: true - summary: Inserts Beam stats for testing - x-soracom-cli: - - sandbox stats beam insert - /sandbox/subscribers/create: - post: responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxCreateSubscriberResponse' + "200": description: OK + "400": + description: Data with the same timestamp already exists. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Inserts Beam stats for testing tags: - - Subscriber + - 'API Sandbox: Stats' + x-soracom-cli: + - sandbox stats beam insert + /sandbox/subscribers/create: + post: description: Creates a new subscriber for sandbox. operationId: sandboxCreateSubscriber requestBody: content: application/json: examples: - Creating "plan01s": - value: - subscription: plan01s Creating "plan-D D-300MB": value: bundle: - D-300MB subscription: plan-D + Creating "plan01s": + value: + subscription: plan01s schema: $ref: '#/components/schemas/sandboxCreateSubscriberRequest' description: Create request - summary: Creates a new subscriber for sandbox. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxCreateSubscriberResponse' + description: OK + security: + - api_key: [] + api_token: [] + summary: Creates a new subscriber for sandbox + tags: + - 'API Sandbox: Subscriber' x-soracom-cli: - - sandbox subscribers create + - sandbox subscribers create components: schemas: TagSet: @@ -283,9 +278,9 @@ components: type: integer applicableBillItemName: enum: - - dailyDataTrafficChargeTotal - - dailyChargeTotal - - dailySoracomBeamRequestChargeTotal + - dailyDataTrafficChargeTotal + - dailyChargeTotal + - dailySoracomBeamRequestChargeTotal example: dailyDataTrafficChargeTotal type: string expiryYearMonth: @@ -295,29 +290,28 @@ components: sandboxCreateCouponResponse: properties: amount: - description: Coupon amount + description: Coupon amount. format: double type: number balance: - description: Balance + description: Balance. format: double type: number billItemName: - description: Bill Item + description: Bill Item. type: string couponCode: - description: Coupon code + description: Coupon code. type: string expiryYearMonth: - description: Year and month of expiration + description: Year and month of expiration. format: yyyyMM type: string type: object sandboxCreateSubscriberRequest: properties: bundles: - description: "Bundle. If necessary, specify one of:" - type: array + description: 'Bundle. If necessary, specify one of:' items: enum: - X3-5MB @@ -327,8 +321,9 @@ components: - DU-100GB - K2-300MB type: string + type: array subscription: - description: "Subscription. Specify one of:" + description: 'Subscription. Specify one of:' enum: - plan01s - plan01s-low_data_volume @@ -343,8 +338,6 @@ components: type: object sandboxCreateSubscriberResponse: properties: - tags: - $ref: '#/components/schemas/TagSet' apn: type: string createdAt: @@ -374,6 +367,8 @@ components: type: string subscription: type: string + tags: + $ref: '#/components/schemas/TagSet' type: object sandboxDataTrafficStats: properties: @@ -402,7 +397,7 @@ components: token: type: string required: - - token + - token type: object sandboxInitRequest: properties: @@ -429,26 +424,32 @@ components: default: true type: boolean required: - - email - - password - - authKeyId - - authKey + - email + - password + - authKeyId + - authKey type: object sandboxInsertAirStatsRequest: properties: dataTrafficStatsMap: - properties: - s1.fast: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.minimum: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.slow: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.standard: - $ref: '#/components/schemas/sandboxDataTrafficStats' + additionalProperties: + $ref: '#/components/schemas/sandboxDataTrafficStats' + description: | + Test data for each speed class, including data for both upload and download, with timestamps. Specify a string representing the speed class as a key. + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` type: object unixtime: - description: UNIX time (in milliseconds) + description: UNIX time (in seconds). format: int64 type: integer type: object @@ -480,7 +481,7 @@ components: $ref: '#/components/schemas/sandboxBeamCounts' type: object unixtime: - description: UNIX time (in milliseconds) + description: UNIX time (in seconds). format: int64 type: integer type: object @@ -491,9 +492,12 @@ components: orderId: type: string required: - - orderId - - operatorId + - orderId + - operatorId type: object - tags: -- name: Coupon +- name: 'API Sandbox: Coupon' +- name: 'API Sandbox: Operator' +- name: 'API Sandbox: Order' +- name: 'API Sandbox: Stats' +- name: 'API Sandbox: Subscriber' diff --git a/generators/assets/sandbox/soracom-sandbox-api.ja.yaml b/generators/assets/sandbox/soracom-sandbox-api.ja.yaml index 1eb0af13..0801d1f5 100644 --- a/generators/assets/sandbox/soracom-sandbox-api.ja.yaml +++ b/generators/assets/sandbox/soracom-sandbox-api.ja.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM SANDBOX API v1 title: SORACOM SANDBOX API - version: 20230703-214017 + version: 20230923-005714 servers: - url: https://api-sandbox.soracom.io/v1 paths: @@ -31,7 +31,7 @@ paths: api_token: [] summary: クーポンを作成する tags: - - Coupon + - 'API Sandbox: Coupon' x-soracom-cli: - sandbox coupons create /sandbox/init: @@ -58,7 +58,7 @@ paths: description: メールアドレスが不正もしくは AuthKeyId, AuthKey が誤っている。 summary: Operator を初期化する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox init /sandbox/operators/{operator_id}: @@ -82,7 +82,7 @@ paths: api_token: [] summary: Operator を削除する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox operators delete /sandbox/operators/token/{email}: @@ -115,7 +115,7 @@ paths: description: メールアドレス、AuthKeyId、AuthKey のいずれかが誤っている。 summary: サインアップトークンを取得する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox operators get-signup-token /sandbox/orders/ship: @@ -139,7 +139,7 @@ paths: api_token: [] summary: Order を出荷済状態にする tags: - - Order + - 'API Sandbox: Order' x-soracom-cli: - sandbox orders ship /sandbox/stats/air/subscribers/{imsi}: @@ -170,7 +170,7 @@ paths: api_token: [] summary: テスト用に Air の統計情報を登録する tags: - - Stats + - 'API Sandbox: Stats' x-soracom-cli: - sandbox stats air insert /sandbox/stats/beam/subscribers/{imsi}: @@ -201,7 +201,7 @@ paths: api_token: [] summary: テスト用に Beam の統計情報を登録する tags: - - Stats + - 'API Sandbox: Stats' x-soracom-cli: - sandbox stats beam insert /sandbox/subscribers/create: @@ -235,7 +235,7 @@ paths: api_token: [] summary: Subscriber を作成する tags: - - Subscriber + - 'API Sandbox: Subscriber' x-soracom-cli: - sandbox subscribers create components: @@ -423,18 +423,24 @@ components: sandboxInsertAirStatsRequest: properties: dataTrafficStatsMap: - properties: - s1.fast: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.minimum: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.slow: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.standard: - $ref: '#/components/schemas/sandboxDataTrafficStats' + additionalProperties: + $ref: '#/components/schemas/sandboxDataTrafficStats' + description: | + 速度クラスごとのテスト用データ (上り下りのデータ通信量、タイムスタンプ付き) です。キーに速度クラスを表す文字列を指定します。 + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` type: object unixtime: - description: UNIX 時間（ミリ秒単位） + description: UNIX 時間 (秒)。 format: int64 type: integer type: object @@ -466,7 +472,7 @@ components: $ref: '#/components/schemas/sandboxBeamCounts' type: object unixtime: - description: UNIX 時間（ミリ秒単位） + description: UNIX 時間 (秒)。 format: int64 type: integer type: object @@ -481,4 +487,8 @@ components: - operatorId type: object tags: -- name: Coupon +- name: 'API Sandbox: Coupon' +- name: 'API Sandbox: Operator' +- name: 'API Sandbox: Order' +- name: 'API Sandbox: Stats' +- name: 'API Sandbox: Subscriber' diff --git a/generators/assets/soracom-api.en.yaml b/generators/assets/soracom-api.en.yaml index 31ffd35d..4f88a175 100644 --- a/generators/assets/soracom-api.en.yaml +++ b/generators/assets/soracom-api.en.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM API v1 title: SORACOM API - version: 20230704-081118 + version: 20231114-075713 servers: - description: Japan coverage production API url: https://api.soracom.io/v1 @@ -11,10 +11,10 @@ servers: paths: /audit_logs/api: get: - description: Retrieve audit logs for API calls. + description: Retrieve audit logs for Soracom API calls. operationId: getApiAuditLogs parameters: - - description: Filter item for audit log retrieval by API kind. + - description: Filter item for audit log retrieval by API kind (e.g. `/v1/auth`). in: query name: api_kind required: false @@ -65,11 +65,11 @@ paths: items: $ref: '#/components/schemas/APIAuditLogEntry' type: array - description: A list of API audit log entries. + description: A list of Soracom API audit log entries. security: - api_key: [] api_token: [] - summary: Retrieve audit logs for API calls + summary: Retrieve audit logs for Soracom API calls tags: - AuditLog x-soracom-cli: @@ -81,10 +81,10 @@ paths: header: x-soracom-next-key /audit_logs/napter: get: - description: Retrieve audit logs for Napter. + description: Retrieve audit logs for Soracom Napter. operationId: getNapterAuditLogs parameters: - - description: Type of the target resource to query Napter audit log entries. + - description: Type of the target resource to query log entries. in: query name: resource_type required: false @@ -162,7 +162,7 @@ paths: security: - api_key: [] api_token: [] - summary: Retrieve audit logs for Napter + summary: Retrieve audit logs for Soracom Napter tags: - AuditLog x-soracom-cli: @@ -327,7 +327,7 @@ paths: description: | Gets a list of finalized past billing history. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBillingHistory responses: "200": @@ -359,9 +359,9 @@ paths: /bills/{yyyyMM}: get: description: | - Gets a finalized past billing history for the specified month. + Gets a finalized past billing history for the specified month. If you specify current month (the month in which the usage fee has not yet been finalized), you will get the preliminary value. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBilling parameters: - description: Target year and month @@ -399,9 +399,9 @@ paths: /bills/{yyyyMM}/daily: get: description: | - Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. + Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. If you specify current month (a month for which the fee has not yet been finalized), a preliminary value will be returned. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBillingPerDay parameters: - description: Target year and month @@ -438,9 +438,9 @@ paths: /bills/{yyyyMM}/export: post: description: | - Issues a URL to download the billing details CSV for the specified month. For more information on billing details CSV, please refer to [Understanding the CSV format](/en/docs/account/billing/#understanding-the-csv-format). + Export historical [Detailed billing CSV](/en/docs/account/billing/#detailed-billing-csv) to dedicated storage and issue URL to download. - **Warning**: You can only download billing details CSV for the past 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: exportBilling parameters: - description: Target year and month @@ -482,17 +482,15 @@ paths: security: - api_key: [] api_token: [] - summary: Issues a URL to download the billing details CSV for the specified - month + summary: Export historical Detailed billing CSV to dedicated storage tags: - Billing x-soracom-cli: - bills export /bills/latest: get: - description: Returns the latest billing amounts after applying discounts such - as free tiers, etc. The amount retrieved by this API is the amount before - the billing is finalized. + description: Retrieves the preliminary usage fee for the current month (the + month in which the usage fee has not yet been finalized). operationId: getLatestBilling responses: "200": @@ -511,13 +509,18 @@ paths: - bills get-latest /bills/latest/export: post: - description: Returns detailed information of the billing amounts for the latest - month. This detailed information includes billing amounts per day, subscriber, - and billing item. The amount retrieved by this API is the amount before the - billing is finalized. + description: Export [Detailed Billing CSV](/en/docs/account/billing/#detailed-billing-csv) + for current month (the month in which the usage fee has not yet been finalized) + to dedicated storage and issue a URL to download it. The fees will be finalized + by the second business day of the following month. The Detailed billing CSV + exported using this API will output preliminary values. operationId: exportLatestBilling parameters: - - description: export_mode (async, sync) + - description: | + Specify how to get the URL to download the billing details CSV. + + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the SORACOM platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`. + - `sync` (default): Wait for the URL to be issued on the SORACOM platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. in: query name: export_mode required: false @@ -552,44 +555,14 @@ paths: /bills/summaries/bill_items: get: description: | - Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + + The summary you can get from this API is equivalent to the usage fees displayed in the [COSTS BY SERVICE] panel of the Billing Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/). operationId: getBillingSummaryOfBillItems responses: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - - amount: 0.09 - billItemCategory: Beam - billItemName: soracomBeamRequestCharge-inHttp - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - amount: 1.8 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfBillItems' @@ -606,39 +579,14 @@ paths: /bills/summaries/sims: get: description: | - Get a billing summary of SIMs for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + Get a billing summary of SIMs for the last 4 months (current month to 3 months ago). Sorted by date from newest to oldest. + + The summary you get from this API is equivalent to the rates displayed in the [COSTS PER SIM (TOP 100)] panel of the Rates Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/). operationId: getBillingSummaryOfSims responses: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - simId: "1234567890123456780" - - amount: 0.12 - simId: "1234567890123456781" - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - - amount: 1.8 - simId: "1234567890123456780" - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfSims' @@ -647,7 +595,7 @@ paths: security: - api_key: [] api_token: [] - summary: Gets a billing summary of SIMs. + summary: Gets a billing summary of SIMs tags: - Billing x-soracom-cli: @@ -655,13 +603,10 @@ paths: /cell_locations: get: description: | - Retrieves location information (latitude / longitude) for a cell - tower which is identified by Cell ID etc. Please specify MCC, MNC, LAC - and CID when the access radio technology is 3G. It is possible to retrieve - location information without CID, but the location information will be low - accuracy. For LTE (4G), please specify MCC, MNC, TAC and ECID. As it is based on - an open database to convert cell information into location information, the - location information does not exist or might be incorrect. + Retrieves location information (latitude / longitude) for a cell tower which is identified by Cell ID etc. + Please specify MCC, MNC, LAC and CID when the access radio technology is 3G. It is possible to retrieve location information without CID, but the location information will be low accuracy. + For LTE (4G), please specify MCC, MNC, TAC and ECID. + As it is based on an open database to convert cell information into location information, the location information does not exist or might be incorrect. 3G example. ``` @@ -669,6 +614,7 @@ paths: -H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \ -H "X-Soracom-Token: $X_SORACOM_TOKEN" ``` + 4G example. ``` $ curl -X GET 'https://api.soracom.io/v1/cell_locations?mcc=440&mnc=10&tac=5840&ecid=44668480' \ @@ -677,49 +623,51 @@ paths: ``` operationId: getCellLocation parameters: - - description: MCC - Mobile Country Code + - description: MCC - Mobile Country Code. example: 440 in: query name: mcc required: true schema: type: string - - description: MNC - Mobile Network Code + - description: MNC - Mobile Network Code. example: 10 in: query name: mnc required: true schema: type: string - - description: LAC - Location Area Code (for 3G) + - description: LAC - Location Area Code (for 3G). example: 195 in: query name: lac required: false schema: type: string - - description: CID - Cell ID (for 3G) + - description: CID - Cell ID (for 3G). example: 68485165 in: query name: cid required: false schema: type: string - - description: TAC - Tracking Area Code (for 4G) + - description: TAC - Tracking Area Code (for 4G). example: 5840 in: query name: tac required: false schema: type: string - - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci` + - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. + The result is the same regardless of which value is specified. example: 44668480 in: query name: ecid required: false schema: type: string - - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci` + - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. + The result is the same regardless of which value is specified. example: 44668480 in: query name: eci @@ -741,20 +689,25 @@ paths: updated: 2022-01-01T00:00:00:000Z schema: $ref: '#/components/schemas/CellLocation' - description: Location information for the cell tower + description: Location information for the cell tower. "404": - description: Location information is not found for the cell tower + description: Location information is not found for the cell tower. security: - api_key: [] api_token: [] - summary: Get location information for a cell tower. + summary: Get location information for a cell tower tags: - CellLocation x-soracom-cli: - cell-locations get post: description: Retrieves a list of location information (latitude / longitude) - for multiple cell towers which are identified by Cell IDs etc. + for multiple cell towers which are identified by Cell IDs etc. Please specify + MCC, MNC, LAC and CID when the access radio technology is 3G. It is possible + to retrieve location information without CID, but the location information + will be low accuracy. For LTE (4G), please specify MCC, MNC, TAC and ECID. + As it is based on an open database to convert cell information into location + information, the location information does not exist or might be incorrect. operationId: batchGetCellLocations requestBody: content: @@ -803,7 +756,7 @@ paths: items: $ref: '#/components/schemas/CellLocation' type: array - description: List of location information for the specified cell towers + description: List of location information for the specified cell towers. security: - api_key: [] api_token: [] @@ -832,7 +785,7 @@ paths: x-soracom-cli: - coupons list post: - description: Creates a new coupon quotation. If the orderId is put in /confirm, + description: Creates a new coupon quotation. If the orderId is put in /coupons/{order_id}/confirm, the order is complete. operationId: createCouponQuotation requestBody: @@ -840,7 +793,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEstimatedCouponRequest' - description: Coupon details + description: Coupon details. required: true responses: "201": @@ -848,11 +801,11 @@ paths: application/json: schema: $ref: '#/components/schemas/EstimatedCouponModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create coupon quotation. + summary: Create coupon quotation tags: - Order x-soracom-cli: @@ -862,7 +815,7 @@ paths: description: Registers a coupon. operationId: registerCoupon parameters: - - description: Coupon code + - description: Coupon code. in: path name: coupon_code required: true @@ -881,7 +834,7 @@ paths: security: - api_key: [] api_token: [] - summary: Register Coupon. + summary: Register Coupon tags: - Payment x-soracom-cli: @@ -908,14 +861,14 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm coupon order. + summary: Confirm coupon order tags: - Order x-soracom-cli: - coupons confirm /credentials: get: - description: Returns a list of credentials. + description: Returns a list of credentials set. operationId: listCredentials responses: "200": @@ -929,17 +882,17 @@ paths: security: - api_key: [] api_token: [] - summary: List of credentials. + summary: List of credentials set tags: - Credential x-soracom-cli: - credentials list /credentials/{credentials_id}: delete: - description: Deletes a credential. + description: Deletes a credentials set. operationId: deleteCredential parameters: - - description: Credentials ID + - description: Credentials set ID. in: path name: credentials_id required: true @@ -947,22 +900,22 @@ paths: type: string responses: "204": - description: Deleted + description: Credentials set has been deleted. "404": - description: Not Found + description: Not Found. security: - api_key: [] api_token: [] - summary: Delete a credential. + summary: Delete a credentials set tags: - Credential x-soracom-cli: - credentials delete post: - description: Creates a new credential. + description: Creates a new credentials set. operationId: createCredential parameters: - - description: credentials_id + - description: Credentials set ID. in: path name: credentials_id required: true @@ -1016,7 +969,7 @@ paths: $ref: '#/components/examples/MockmockDatarecorderCredentials' schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true responses: "201": @@ -1024,20 +977,20 @@ paths: application/json: schema: $ref: '#/components/schemas/CredentialsModel' - description: Created + description: Credentials set has been created. security: - api_key: [] api_token: [] - summary: Create a credential. + summary: Create a credentials set tags: - Credential x-soracom-cli: - credentials create put: - description: Updates a credential. + description: Updates a credentials set. operationId: updateCredential parameters: - - description: credentials_id + - description: Credentials set ID. in: path name: credentials_id required: true @@ -1048,7 +1001,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true responses: "200": @@ -1064,7 +1017,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update a credential. + summary: Update a credentials set tags: - Credential x-soracom-cli: @@ -1125,11 +1078,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: Key in the last data entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the @@ -2058,11 +2014,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -2298,7 +2257,7 @@ paths: description: Returns a list of event handlers. operationId: listEventHandlers parameters: - - description: target + - description: The event handler target (the target for executing events). in: query name: target required: false @@ -2321,20 +2280,20 @@ paths: security: - api_key: [] api_token: [] - summary: List Event Handlers. + summary: List Event Handlers tags: - EventHandler x-soracom-cli: - event-handlers list post: - description: Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/ + description: Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/. operationId: createEventHandler requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEventHandlerRequest' - description: event handler settings + description: Event handler settings. required: true responses: "201": @@ -2342,11 +2301,11 @@ paths: application/json: schema: $ref: '#/components/schemas/EventHandlerModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Event Handler. + summary: Create Event Handler tags: - EventHandler x-soracom-cli: @@ -2356,7 +2315,7 @@ paths: description: Deletes the specified event handler. operationId: deleteEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2366,11 +2325,11 @@ paths: "204": description: OK. "404": - description: EventHandler not found. + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Delete Event Handler. + summary: Delete Event Handler tags: - EventHandler x-soracom-cli: @@ -2379,7 +2338,7 @@ paths: description: Returns information about the specified event handler. operationId: getEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2393,20 +2352,20 @@ paths: $ref: '#/components/schemas/EventHandlerModel' description: OK. "404": - description: Handler not found. + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Get Event Handler. + summary: Get Event Handler tags: - EventHandler x-soracom-cli: - event-handlers get put: - description: Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/ + description: Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/. operationId: updateEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2417,17 +2376,17 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateEventHandlerRequest' - description: event handler settings + description: Event handler settings. required: true responses: "200": description: OK. "400": - description: Invalid handlerId. + description: Invalid event handler ID. security: - api_key: [] api_token: [] - summary: Update Event Handler. + summary: Update Event Handler tags: - EventHandler x-soracom-cli: @@ -2438,13 +2397,13 @@ paths: the specified IMSI. operationId: deleteIgnoreEventHandler parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true schema: type: string - - description: handler_id + - description: Event handler ID. in: path name: handler_id required: true @@ -2452,13 +2411,13 @@ paths: type: string responses: "204": - description: OK + description: OK. "404": - description: not found + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Delete Ignore Event Handler. + summary: Delete Ignore Event Handler tags: - EventHandler x-soracom-cli: @@ -2468,13 +2427,13 @@ paths: specified IMSI. operationId: setIgnoreEventHandler parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true schema: type: string - - description: handler_id + - description: Event handler ID. in: path name: handler_id required: true @@ -2482,11 +2441,11 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Ignore Event Handler. + summary: Ignore Event Handler tags: - EventHandler x-soracom-cli: @@ -2496,7 +2455,7 @@ paths: description: Returns a list of event handlers related to the specified IMSI. operationId: listEventHandlersBySubscriber parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true @@ -2512,11 +2471,11 @@ paths: type: array description: OK. "404": - description: not found + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: List Event Handlers related to Subscriber. + summary: List Event Handlers related to Subscriber tags: - EventHandler x-soracom-cli: @@ -2680,11 +2639,20 @@ paths: type: string responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FileEntry' description: Metadata of the file + headers: + Content-Length: + description: File size (bytes) + schema: + type: integer + Content-Type: + description: File's Content-Type + schema: + type: string + ETag: + description: Identifier representing the file version + schema: + type: string "404": description: No such file. security: @@ -2883,12 +2851,15 @@ paths: - files get-exported /gadgets: get: - description: Returns a list of gadgets that match certain criteria. If the total - number of gadgets does not fit in one page, a URL for accessing the next page - is returned in the 'Link' header of the response. + description: | + Returns a list of gadgets that match certain criteria. If the total number of gadgets does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listGadgets parameters: - - description: Product ID for filtering the search. + - description: | + Product ID of the target Gadget API compatible device for filtering the search. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: query name: product_id required: false @@ -2897,20 +2868,25 @@ paths: - button - wimax type: string - - description: Tag name for filtering the search (exact match). + - description: Tag name for filtering the search. The search is always an exact + match, regardless of the setting of `tag_value_match_mode`. in: query name: tag_name required: false schema: type: string - - description: Tag search string for filtering the search. Required when `tag_name` - has been specified. + - description: Specifies a tag value to search for in a URL-encoded (percent-encoded) + string. Required when `tag_name` has been specified. in: query name: tag_value required: false schema: type: string - - description: Tag match mode. + - description: | + Tag match mode. + + - `exact`: exact match. + - `prefix`: prefix match. in: query name: tag_value_match_mode required: false @@ -2920,15 +2896,18 @@ paths: - exact - prefix type: string - - description: Maximum number of gadgets to retrieve. + - description: Maximum number of Gadget API compatible devices data to retrieve. in: query name: limit required: false schema: type: integer - - description: The ID ({product_id}/{serial_number}) of the last gadget retrieved - on the current page. By specifying this parameter, you can continue to retrieve - the list from the next device onward. + - description: | + The ID (`{product_id}/{serial_number}`) of the last gadget retrieved on the previous page in URL encoding (percent encoding). + + By specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward. + + The value of the `last_evaluated_key` of `rel=next` returned in the `link` header when the API is called is expected to be specified in the next call, but any ID (`{productId}/{serialNumber}`) can be specified. in: query name: last_evaluated_key required: false @@ -2963,11 +2942,11 @@ paths: items: $ref: '#/components/schemas/Gadget' type: array - description: A list of Gadgets. + description: A list of Gadget API compatible devices. security: - api_key: [] api_token: [] - summary: List gadgets. + summary: List gadgets tags: - Gadget x-soracom-cli: @@ -2979,10 +2958,14 @@ paths: header: x-soracom-next-key /gadgets/{product_id}/{serial_number}: get: - description: Returns information about the specified gadget. + description: Returns information about the specified Gadget API compatible device. operationId: getGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -2991,7 +2974,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3024,23 +3007,28 @@ paths: terminationEnabled: false schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information. + description: Detailed information about the specified Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Get gadget. + summary: Get Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets get /gadgets/{product_id}/{serial_number}/disable_termination: post: - description: Disables termination of specified gadget. + description: Disables termination of specified Gadget API compatible device. operationId: disableTerminationOnGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3049,7 +3037,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3061,23 +3049,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Disable Termination of gadget. + summary: Disables Termination of Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets disable-termination /gadgets/{product_id}/{serial_number}/enable_termination: post: - description: Enables termination of specified gadget. + description: Enables termination of specified Gadget API compatible device. operationId: enableTerminationOnGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3086,7 +3079,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3098,23 +3091,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Enable Termination of gadget. + summary: Enables Termination of Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets enable-termination /gadgets/{product_id}/{serial_number}/register: post: - description: Registers a gadget + description: Registers a Gadget API compatible device. operationId: registerGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3123,7 +3121,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3134,7 +3132,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GadgetRegistrationRequest' - description: Gadget registration request + description: Gadget registration request. required: true responses: "200": @@ -3142,23 +3140,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: Gadget successfully registered + description: Gadget API compatible device successfully registered. "404": description: No such resource found. security: - api_key: [] api_token: [] - summary: Register a gadget. + summary: Registers a Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets register /gadgets/{product_id}/{serial_number}/tags: put: - description: Inserts/updates tags for the specified gadget. + description: Inserts/updates tags for the specified Gadget API compatible device. operationId: putGadgetTags parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3167,7 +3169,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3188,23 +3190,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update gadget Tags. + summary: Bulk Insert or Update Gadget API compatible device tags tags: - Gadget x-soracom-cli: - gadgets put-tags /gadgets/{product_id}/{serial_number}/tags/{tag_name}: delete: - description: Deletes a tag from the specified gadget. + description: Deletes a tag from the specified Gadget API compatible device. operationId: deleteGadgetTag parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3213,7 +3220,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3231,11 +3238,12 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified gadget or the tag does not exist. + description: The specified Gadget API compatible devices or the tags does + not exist. security: - api_key: [] api_token: [] - summary: Delete gadget Tag. + summary: Deletes tags from Gadget API compatible device tags: - Gadget x-sam-operationId: deleteTag @@ -3243,10 +3251,14 @@ paths: - gadgets delete-tag /gadgets/{product_id}/{serial_number}/terminate: post: - description: Terminates the specified gadget + description: Terminates the specified Gadget API compatible device. operationId: terminateGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3255,7 +3267,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3267,20 +3279,21 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Terminate gadget. + summary: Terminates the specified Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets terminate /groups: get: - description: Returns a list of groups. + description: Returns a list of Groups. operationId: listGroups parameters: - description: Tag name of the group. Filters through all groups that exactly @@ -3296,7 +3309,7 @@ paths: required: false schema: type: string - - description: Tag match mode. + - description: Search criteria for tag strings (`tag_value`). in: query name: tag_value_match_mode required: false @@ -3348,31 +3361,59 @@ paths: requestBody: content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + tags: + name: Group name schema: $ref: '#/components/schemas/CreateGroupRequest' - description: Tags for group to be created. + description: Tags and configuration for a new group to be created. required: true responses: "201": content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + createdAt: 1698796800000 + createdTime: 1698796800000 + groupId: 12345678-abcd-9012-efab-345678901234 + lastModifiedAt: 1698796800000 + lastModifiedTime: 1698796800000 + operatorId: OP0012345678 + tags: + name: Group name schema: $ref: '#/components/schemas/Group' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Group. + summary: Create Group tags: - Group x-soracom-cli: - groups create /groups/{group_id}: delete: - description: Deletes the specified group by group ID + description: Deletes the group specified by Group ID. operationId: deleteGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3386,7 +3427,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group. + summary: Delete Group tags: - Group x-soracom-cli: @@ -3395,7 +3436,7 @@ paths: description: Returns the group specified by the group ID. operationId: getGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3407,13 +3448,13 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: The specified group. + description: Specified Group. "404": description: The specified group does not exist. security: - api_key: [] api_token: [] - summary: Get Group. + summary: Get Group tags: - Group x-soracom-cli: @@ -3423,7 +3464,7 @@ paths: description: Delete a namespace for the specified group. operationId: deleteConfigurationNamespace parameters: - - description: Target group. + - description: ID of the target Group. in: path name: group_id required: true @@ -3438,6 +3479,7 @@ paths: - SoracomAir - SoracomBeam - SoracomEndorse + - SoracomOrbit - SoracomFunk - SoracomFunnel - SoracomHarvest @@ -3455,7 +3497,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group Configuration Namespace. + summary: Delete Group Configuration Namespace tags: - Group x-soracom-cli: @@ -3464,7 +3506,8 @@ paths: description: Adds/updates parameters for the specified group. operationId: putConfigurationParameters parameters: - - description: Target group. + - description: ID of the target Group. It can be obtained via [`Group:listGroups + API`](#/Group/listGroups). in: path name: group_id required: true @@ -3545,7 +3588,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Group Configuration Parameters. + summary: Update Group Configuration Parameters tags: - Group x-soracom-cli: @@ -3555,7 +3598,7 @@ paths: description: Delete parameters for the specified group. operationId: deleteConfigurationParameter parameters: - - description: Target group. + - description: ID of the target Group. in: path name: group_id required: true @@ -3593,7 +3636,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group Configuration Parameters. + summary: Delete Group Configuration Parameters tags: - Group x-soracom-cli: @@ -3604,7 +3647,7 @@ paths: by group ID. operationId: listSubscribersInGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3629,14 +3672,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Group' - description: Target group ID + items: + $ref: '#/components/schemas/Sim' + type: array + description: Specified Group. "404": description: The specified group does not exist. security: - api_key: [] api_token: [] - summary: List Subscribers in a group. + summary: List Subscribers in a group tags: - Group x-sam-operationId: listSubscribers @@ -3652,7 +3697,7 @@ paths: description: Adds/updates tags of specified configuration group. operationId: putGroupTags parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3679,7 +3724,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Group Tags. + summary: Update Group Tags tags: - Group x-sam-operationId: putTags @@ -3690,7 +3735,7 @@ paths: description: Deletes tag from the specified group. operationId: deleteGroupTag parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3708,11 +3753,11 @@ paths: "204": description: Tag deletion complete. "404": - description: The specified subscriber or the tag does not exist. + description: The specified group or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete Group Tag. + summary: Delete Group Tag tags: - Group x-sam-operationId: deleteTag @@ -3721,12 +3766,12 @@ paths: /lagoon/dashboards/{dashboard_id}/permissions: put: description: | - Update permissions for a SORACOM Lagoon 2 dashboard. + Update permissions for a Soracom Lagoon 2 dashboard. - **Warning**: A SORACOM Lagoon 3 dashboard cannot be updated with this API. + **Warning**: A Soracom Lagoon 3 dashboard cannot be updated with this API. operationId: updateLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: ID of the target Dashboard. in: path name: dashboard_id required: true @@ -3746,19 +3791,19 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonDashboardPermissionsUpdatingRequest' - description: req + description: Request. required: true responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "403": - description: Unauthorized operation + description: Unauthorized operation. security: - api_key: [] api_token: [] - summary: Update permissions for a SORACOM Lagoon 2 dashboard + summary: Update permissions for a Soracom Lagoon 2 dashboard tags: - Lagoon x-soracom-cli: @@ -3766,20 +3811,21 @@ paths: /lagoon/dashboards/{dashboard_id}/permissions/init: post: description: | - Update permissions to the initial state for a SORACOM Lagoon 2 dashboard. + Update permissions to the initial state for a Soracom Lagoon 2 dashboard. - **Warning**: This API cannot update permissions for a SORACOM Lagoon 3 dashboard. + **Warning**: This API cannot update permissions for a Soracom Lagoon 3 dashboard. operationId: initializeLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: ID of the target Dashboard. in: path name: dashboard_id required: true schema: format: int64 type: integer - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3787,26 +3833,30 @@ paths: type: boolean responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "403": - description: Unauthorized operation + description: Unauthorized operation. security: - api_key: [] api_token: [] - summary: Update permissions to the initial state for a SORACOM Lagoon 2 dashboard + summary: Update permissions to the initial state for a Soracom Lagoon 2 dashboard tags: - Lagoon x-soracom-cli: - lagoon dashboards init-permissions /lagoon/dashboards/permissions: get: - description: List permissions for all SORACOM Lagoon 2 dashboards + description: | + List permissions for all Soracom Lagoon 2 dashboards. + + **Warning**: This API cannot obtain Dashboard permissions for Soracom Lagoon 3. operationId: listLagoonDashboardsPermissions parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3820,24 +3870,25 @@ paths: items: $ref: '#/components/schemas/LagoonDashboardPermissionsResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: List permissions for all SORACOM Lagoon 2 dashboards + summary: List permissions for all Soracom Lagoon 2 dashboards tags: - Lagoon x-soracom-cli: - lagoon dashboards list-permissions /lagoon/image/link: get: - description: Get a custom icon image link of SORACOM Lagoon Console + description: Get a custom icon image link of Soracom Lagoon Console. operationId: getImageLink parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3849,20 +3900,20 @@ paths: application/json: schema: type: string - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get a custom icon image link of SORACOM Lagoon Console + summary: Get a custom icon image link of Soracom Lagoon Console tags: - Lagoon x-soracom-cli: - lagoon get-image-link /lagoon/license_packs: get: - description: Get the status of active SORACOM Lagoon license packs + description: Get the status of active Soracom Lagoon license packs. operationId: listLagoonLicensePackStatus responses: "200": @@ -3872,65 +3923,65 @@ paths: items: $ref: '#/components/schemas/LagoonLicensePackStatusResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get the status of active SORACOM Lagoon license packs + summary: Get the status of active Soracom Lagoon license packs tags: - Lagoon x-soracom-cli: - lagoon license-packs list-status put: description: | - Update the quantities for license packs of SORACOM Lagoon. + Update the quantities for license packs of Soracom Lagoon. - **Warning**: This API must be called with the root user credentials. The quantities for license packs of SORACOM Lagoon cannot be updated with SAM user credentials. + **Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials. operationId: updateLagoonLicensePack requestBody: content: application/json: schema: $ref: '#/components/schemas/LagoonLicensePacksUpdatingRequest' - description: req + description: Request. required: true responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "404": - description: Operator Not Found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Update the quantities for license packs of SORACOM Lagoon + summary: Update the quantities for license packs of Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon license-packs update /lagoon/migration: get: - description: Get the version migration information for SORACOM Lagoon. Only + description: Get the version migration information for Soracom Lagoon. Only the root account can operate this. operationId: getLagoonMigrationInfo requestBody: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "200": - description: OK. The response body contains the Lagoon migration information. + description: The response body contains the Lagoon migration information. security: - api_key: [] api_token: [] - summary: Get the version migration information for SORACOM Lagoon + summary: Get the version migration information for Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon migration get-info post: - description: Migrate SORACOM Lagoon version. Only the root account can operate + description: Migrate Soracom Lagoon version. Only the root account can operate this. operationId: migrateLagoon requestBody: @@ -3938,15 +3989,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonMigrationRequest' - description: req + description: Request. required: true responses: "200": - description: OK. It has finished the Lagoon migration. + description: It has finished the Lagoon migration. security: - api_key: [] api_token: [] - summary: Migrate SORACOM Lagoon version + summary: Migrate Soracom Lagoon version tags: - Lagoon x-soracom-cli: @@ -3954,7 +4005,7 @@ paths: /lagoon/plan: put: description: | - Update the plan of SORACOM Lagoon. + Update the plan of Soracom Lagoon. **Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials. operationId: updateLagoonPlan @@ -3962,15 +4013,15 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "404": - description: Operator Not Found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Update the plan of SORACOM Lagoon + summary: Update the plan of Soracom Lagoon tags: - Lagoon x-soracom-cli: @@ -3978,7 +4029,7 @@ paths: /lagoon/register: post: description: | - Register (activate) SORACOM Lagoon. + Register (activate) Soracom Lagoon. **Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials. operationId: registerLagoon @@ -3987,7 +4038,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationRequest' - description: request + description: Request. required: true responses: "201": @@ -3995,13 +4046,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationResponse' - description: Registered + description: Registered. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Register (activate) SORACOM Lagoon + summary: Register (activate) Soracom Lagoon tags: - Lagoon x-soracom-cli: @@ -4009,32 +4060,33 @@ paths: /lagoon/terminate: post: description: | - Terminate (deactivate) SORACOM Lagoon. + Terminate (deactivate) Soracom Lagoon. **Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials. operationId: terminateLagoon responses: "204": - description: Terminated + description: Terminated. "400": - description: Bad request + description: Bad request. "404": - description: Operator not found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Terminate (deactivate) SORACOM Lagoon + summary: Terminate (deactivate) Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon terminate /lagoon/users: get: - description: List SORACOM Lagoon users that belong to operator. + description: List Soracom Lagoon users that belong to operator. operationId: listLagoonUsers parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -4048,27 +4100,27 @@ paths: items: $ref: '#/components/schemas/LagoonUser' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: List SORACOM Lagoon users that belong to operator + summary: List Soracom Lagoon users that belong to operator tags: - Lagoon x-soracom-cli: - lagoon list-users - lagoon users list post: - description: Create a SORACOM Lagoon user. + description: Create a Soracom Lagoon user. operationId: createLagoonUser requestBody: content: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationRequest' - description: request + description: Request. required: true responses: "201": @@ -4076,13 +4128,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationResponse' - description: Created + description: Created. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Create a SORACOM Lagoon user + summary: Create a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4090,10 +4142,10 @@ paths: - lagoon users create /lagoon/users/{lagoon_user_id}: delete: - description: Delete a SORACOM Lagoon user. + description: Delete a Soracom Lagoon user. operationId: deleteLagoonUser parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4101,13 +4153,13 @@ paths: type: integer responses: "204": - description: Deleted + description: Deleted. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Delete a SORACOM Lagoon user + summary: Delete a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4115,10 +4167,10 @@ paths: - lagoon users delete /lagoon/users/{lagoon_user_id}/email: put: - description: Update email address of a SORACOM Lagoon user. + description: Update email address of a Soracom Lagoon user. operationId: updateLagoonUserEmail parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4129,17 +4181,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserEmailUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update email address of a SORACOM Lagoon user + summary: Update email address of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4147,10 +4199,10 @@ paths: - lagoon users update-email /lagoon/users/{lagoon_user_id}/password: put: - description: Update password of a SORACOM Lagoon user. + description: Update password of a Soracom Lagoon user. operationId: updateLagoonUserPassword parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4161,17 +4213,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPasswordUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update password of a SORACOM Lagoon user + summary: Update password of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4179,10 +4231,10 @@ paths: - lagoon users update-password /lagoon/users/{lagoon_user_id}/permission: put: - description: Update permission of a SORACOM Lagoon user. + description: Update permission of a Soracom Lagoon user. operationId: updateLagoonUserPermission parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4193,17 +4245,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPermissionUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update permission of a SORACOM Lagoon user + summary: Update permission of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4211,9 +4263,8 @@ paths: - lagoon users update-permission /logs: get: - description: Returns a list of log entries that match certain criteria. If the - total number of entries does not fit in one page, a URL for accessing the - next page is returned in the 'Link' header of the response. + description: | + Returns a list of log entries that match certain criteria. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: getLogs parameters: - description: Type of the target resource to query log entries. @@ -4247,13 +4298,13 @@ paths: - Funnel - Gate type: string - - description: Start time for the log search range (unixtime). + - description: Start time for the log search range (UNIX time in milliseconds). in: query name: from required: false schema: type: integer - - description: End time for the log search range (unixtime). + - description: End time for the log search range (UNIX time in milliseconds). in: query name: to required: false @@ -4285,7 +4336,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Logs. + summary: Get Logs tags: - Log x-soracom-cli: @@ -4423,11 +4474,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -4756,9 +4810,8 @@ paths: - lora-devices unset-group /lora_gateways: get: - description: Returns a list of LoRa gateways that match certain criteria. If - the total number of LoRa gateways does not fit in one page, a URL for accessing - the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN gateways that match certain criteria. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listLoraGateways parameters: - description: Tag name for filtering the search (exact match). @@ -4784,16 +4837,16 @@ paths: - exact - prefix type: string - - description: Maximum number of LoRa devices to retrieve. + - description: Maximum number of LoRaWAN gateways to retrieve. in: query name: limit required: false schema: format: int32d type: integer - - description: The device ID of the last device retrieved on the current page. - By specifying this parameter, you can continue to retrieve the list from - the next device onward. + - description: The Gateway ID of the last LoRaWAN gateway retrieved on the current + page. By specifying this parameter, you can continue to retrieve the list + from the next LoRaWAN gateway onward. in: query name: last_evaluated_key required: false @@ -4807,11 +4860,11 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: A list of LoRa gateways. + description: A list of LoRaWAN gateways. security: - api_key: [] api_token: [] - summary: List LoRa Gateways. + summary: List LoRaWAN Gateways tags: - LoraGateway x-soracom-cli: @@ -4823,10 +4876,10 @@ paths: header: x-soracom-next-key /lora_gateways/{gateway_id}: get: - description: Returns information about the specified LoRa gateway. + description: Returns information about the specified LoRaWAN gateway. operationId: getLoraGateway parameters: - - description: Gateway ID of the target LoRa gateway. + - description: Gateway ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4838,23 +4891,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information. + description: The LoRaWAN gateway's detailed information. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Get LoRa gateway. + summary: Get LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways get /lora_gateways/{gateway_id}/disable_termination: post: - description: Disables termination of specified LoRa gateway. + description: Disables termination of specified LoRaWAN gateway. operationId: disableTerminationOnLoraGateway parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4866,23 +4919,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Disable Termination of LoRa gateway. + summary: Disable Termination of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways disable-termination /lora_gateways/{gateway_id}/enable_termination: post: - description: Enables termination of specified LoRa gateway. + description: Enables termination of specified LoRaWAN gateway. operationId: enableTerminationOnLoraGateway parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4894,23 +4947,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Enable Termination of LoRa gateway. + summary: Enable Termination of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways enable-termination /lora_gateways/{gateway_id}/set_network_set: post: - description: Sets or overwrites network set ID for the specified LoRa gateway. + description: Sets or overwrites network set ID for the specified LoRaWAN gateway. operationId: setLoraNetworkSet parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4921,30 +4974,30 @@ paths: text/plain: schema: $ref: '#/components/schemas/SetNetworkSetRequest' - description: LoRa Network Set ID. + description: LoRaWAN Network Set ID. responses: "200": content: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa device does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Set Network Set ID of LoRa gateway. + summary: Set Network Set ID of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways set-network-set /lora_gateways/{gateway_id}/tags: put: - description: Inserts/updates tags for the specified LoRa gateway. + description: Inserts/updates tags for the specified LoRaWAN gateway. operationId: putLoraGatewayTags parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4965,31 +5018,31 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update LoRa gateway Tags. + summary: Bulk Insert or Update LoRaWAN gateway Tags tags: - LoraGateway x-soracom-cli: - lora-gateways put-tags /lora_gateways/{gateway_id}/tags/{tag_name}: delete: - description: Deletes a tag from the specified LoRa gateway. + description: Deletes a tag from the specified LoRaWAN gateway. operationId: deleteLoraGatewayTag parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true schema: type: string - - description: Name of tag to be deleted. (This will be part of a URL path, - so it needs to be percent-encoded. In JavaScript, specify the name after - it has been encoded using encodeURIComponent().) + - description: Tag name to be deleted. (This will be part of a URL path, so + it needs to be percent-encoded. In JavaScript, specify the name after it + has been encoded using encodeURIComponent().) in: path name: tag_name required: true @@ -4999,21 +5052,21 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified LoRa gateway or the tag does not exist. + description: The specified LoRaWAN gateway or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa gateway tag. + summary: Delete LoRaWAN gateway tag tags: - LoraGateway x-soracom-cli: - lora-gateways delete-tag /lora_gateways/{gateway_id}/terminate: post: - description: Terminates the specified LoRa gateway + description: Terminates the specified LoRaWAN gateway. operationId: terminateLoraGateway parameters: - - description: Device ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -5025,23 +5078,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Terminate LoRa gateway. + summary: Terminate LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways terminate /lora_gateways/{gateway_id}/unset_network_set: post: - description: Unset network set ID of the specified LoRa gateway. + description: Unset network set ID of the specified LoRaWAN gateway. operationId: unsetLoraNetworkSet parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -5053,22 +5106,21 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Unset Network Set ID of LoRa gateway. + summary: Unset Network Set ID of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways unset-network-set /lora_network_sets: get: - description: Returns a list of LoRa network sets that match certain criteria. - If the total number of LoRa network sets does not fit in one page, a URL for - accessing the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN network sets that match certain criteria. If the total number of LoRaWAN network sets does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listLoraNetworkSets parameters: - description: Tag name for filtering the search (exact match). @@ -5094,7 +5146,7 @@ paths: - exact - prefix type: string - - description: Maximum number of LoRa devices to retrieve. + - description: Maximum number of LoRaWAN network set to retrieve. in: query name: limit required: false @@ -5117,11 +5169,11 @@ paths: items: $ref: '#/components/schemas/LoraNetworkSet' type: array - description: A list of LoRa network sets. + description: A list of LoRaWAN network sets. security: - api_key: [] api_token: [] - summary: List LoRa Network Sets. + summary: List LoRaWAN Network Sets tags: - LoraNetworkSet x-soracom-cli: @@ -5132,14 +5184,15 @@ paths: response: header: x-soracom-next-key post: - description: Creates a specified LoRa network set + description: Creates a specified LoRaWAN network set. operationId: createLoraNetworkSet requestBody: content: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: Additional metadata such as tags for a LoRa network set to create. + description: Additional metadata such as tags for a LoRaWAN network set to + create. required: true responses: "201": @@ -5147,21 +5200,21 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: A LoRa network set was created. + description: A LoRaWAN network set was created. security: - api_key: [] api_token: [] - summary: Create a LoRa network set. + summary: Create a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets create /lora_network_sets/{ns_id}: delete: - description: Deletes the specified LoRa network set + description: Deletes the specified LoRaWAN network set. operationId: deleteLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5171,20 +5224,20 @@ paths: "204": description: Successfully deleted. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa network set. + summary: Delete LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete get: - description: Returns information about the specified LoRa network set. + description: Returns information about the specified LoRaWAN network set. operationId: getLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5196,13 +5249,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: The LoRa network set's detailed information. + description: The LoRaWAN network set's detailed information. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Get LoRa network set. + summary: Get LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: @@ -5212,7 +5265,7 @@ paths: description: Adds permission to allow another operator to use the network set. operationId: addPermissionToLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5235,34 +5288,33 @@ paths: security: - api_key: [] api_token: [] - summary: Adds permission to a LoRa network set. + summary: Adds permission to a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets add-permission /lora_network_sets/{ns_id}/gateways: get: - description: Returns a list of LoRa gateways that belong to the specified network - set. If the total number of LoRa gateways does not fit in one page, a URL - for accessing the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN gateways that belong to the specified network set. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listGatewaysInLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true schema: type: string - - description: Maximum number of LoRa gateways to retrieve. + - description: Maximum number of LoRaWAN gateways to retrieve. in: query name: limit required: false schema: format: int32d type: integer - - description: The ID of the last gateway retrieved on the current page. By - specifying this parameter, you can continue to retrieve the list from the - next device onward. + - description: The Gateway ID of the last LoRaWAN gateway retrieved on the current + page. By specifying this parameter, you can continue to retrieve the list + from the next LoRaWAN gateway onward. in: query name: last_evaluated_key required: false @@ -5276,13 +5328,13 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: A list of LoRa gateways. + description: A list of LoRaWAN gateways. "404": - description: The specified network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: List LoRa Gateways in a Network Set. + summary: List LoRaWAN Gateways in a Network Set tags: - LoraNetworkSet x-soracom-cli: @@ -5298,7 +5350,7 @@ paths: operators in the network set. operationId: revokePermissionFromLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5321,17 +5373,17 @@ paths: security: - api_key: [] api_token: [] - summary: Revokes a permission from a LoRa network set. + summary: Revokes a permission from a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets revoke-permission /lora_network_sets/{ns_id}/tags: put: - description: Inserts/updates tags for the specified LoRa network set. + description: Inserts/updates tags for the specified LoRaWAN network set. operationId: putLoraNetworkSetTags parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5352,31 +5404,31 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: The LoRa network set's detailed information after the update. + description: The LoRaWAN network set's detailed information after the update. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update LoRa network set tags. + summary: Bulk Insert or Update LoRaWAN network set tags tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets put-tag /lora_network_sets/{ns_id}/tags/{tag_name}: delete: - description: Deletes a tag from the specified LoRa network set. + description: Deletes a tag from the specified LoRaWAN network set. operationId: deleteLoraNetworkSetTag parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true schema: type: string - - description: Name of tag to be deleted. (This will be part of a URL path, - so it needs to be percent-encoded. In JavaScript, specify the name after - it has been encoded using encodeURIComponent().) + - description: Tag name to be deleted. (This will be part of a URL path, so + it needs to be percent-encoded. In JavaScript, specify the name after it + has been encoded using encodeURIComponent().) in: path name: tag_name required: true @@ -5386,48 +5438,21 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified LoRa network set or the tag does not exist. + description: The specified LoRaWAN network set or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa network set tag. + summary: Delete LoRaWAN network set tag tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete-tag - /operators: - post: - description: Makes a request to create a new operator. An e-mail is sent to - the e-mail address specified in the parameters, containing a one-time token - for verifying the operator’s registration. - operationId: createOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterOperatorsRequest' - description: email, password - required: true - responses: - "201": - description: Operator created. - "400": - description: The e-mail address is already registered or the password has - an incorrect format. - security: - - api_key: [] - api_token: [] - summary: Create Operator. - tags: - - Operator - x-soracom-cli: - - operator create /operators/{operator_id}: get: description: Returns information about the operator. operationId: getOperator parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5441,11 +5466,11 @@ paths: $ref: '#/components/schemas/GetOperatorResponse' description: OK. "400": - description: Invalid Operator Id + description: Invalid Operator Id. security: - api_key: [] api_token: [] - summary: Get Operator. + summary: Get Operator tags: - Operator x-soracom-cli: @@ -5455,7 +5480,7 @@ paths: description: Returns the operator's AuthKey list. operationId: listOperatorAuthKeys parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5473,7 +5498,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Operator AuthKeys. + summary: List Operator AuthKeys tags: - Operator x-soracom-cli: @@ -5482,7 +5507,7 @@ paths: description: Generates an AuthKey for the operator. operationId: generateOperatorAuthKey parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5498,7 +5523,7 @@ paths: security: - api_key: [] api_token: [] - summary: Generate Operator AuthKey. + summary: Generate Operator AuthKey tags: - Operator x-soracom-cli: @@ -5508,13 +5533,13 @@ paths: description: Deletes an AuthKey from the operator. operationId: deleteOperatorAuthKey parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: auth_key_id + - description: AuthKey ID. in: path name: auth_key_id required: true @@ -5526,7 +5551,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Operator AuthKey. + summary: Delete Operator AuthKey tags: - Operator x-soracom-cli: @@ -5536,7 +5561,7 @@ paths: description: Gets the operator's company information. operationId: getCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5552,7 +5577,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get company information. + summary: Get company information tags: - Operator x-soracom-cli: @@ -5561,7 +5586,7 @@ paths: description: Creates the operator's company information. operationId: createCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5572,7 +5597,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: Model. required: true responses: "201": @@ -5580,7 +5605,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create company information. + summary: Create company information tags: - Operator x-soracom-cli: @@ -5589,7 +5614,7 @@ paths: description: Updates the operator's company information. operationId: updateCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5600,7 +5625,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: Model. required: true responses: "200": @@ -5608,7 +5633,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update company information. + summary: Update company information tags: - Operator x-soracom-cli: @@ -5618,13 +5643,13 @@ paths: description: Deletes operator configuration of the namespace. operationId: deleteOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5640,7 +5665,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete operator configuration of the namespace. + summary: Delete operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5649,13 +5674,13 @@ paths: description: Gets operator configuration of the namespace. operationId: getOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5675,7 +5700,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get operator configuration of the namespace. + summary: Get operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5684,13 +5709,13 @@ paths: description: Sets operator configuration of the namespace. operationId: setOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5717,7 +5742,7 @@ paths: security: - api_key: [] api_token: [] - summary: Set operator configuration of the namespace. + summary: Set operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5727,7 +5752,7 @@ paths: description: Adds the operator's contract. operationId: addOperatorContract parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5738,7 +5763,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContractUpdatingRequest' - description: model + description: Model. required: true responses: "200": @@ -5750,7 +5775,7 @@ paths: security: - api_key: [] api_token: [] - summary: Add Operator Contract. + summary: Add Operator Contract tags: - Operator x-soracom-cli: @@ -5760,13 +5785,13 @@ paths: description: Deletes the operator's contract. operationId: deleteOperatorContract parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: contract_name + - description: Contract name. in: path name: contract_name required: true @@ -5774,11 +5799,11 @@ paths: type: string responses: "204": - description: No Content. + description: Deleted. security: - api_key: [] api_token: [] - summary: Delete Operator Contract. + summary: Delete Operator Contract tags: - Operator x-soracom-cli: @@ -5788,13 +5813,13 @@ paths: description: Adds the operator's coverage type. operationId: addCoverageType parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: coverage_type + - description: Coverage type. in: path name: coverage_type required: true @@ -5806,7 +5831,7 @@ paths: security: - api_key: [] api_token: [] - summary: Add coverage type. + summary: Add coverage type tags: - Operator x-soracom-cli: @@ -5816,7 +5841,7 @@ paths: description: Returns a list of email addresses. operationId: listEmails parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5833,7 +5858,7 @@ paths: description: OK. "400": description: | - This operation is allowed only for root user. + Invoked using SAM user credentials. This operation is allowed only for root user. security: - api_key: [] api_token: [] @@ -5847,13 +5872,13 @@ paths: description: Deletes an email address. operationId: deleteEmail parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: email_id + - description: Email address ID. in: path name: email_id required: true @@ -5861,7 +5886,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -5874,13 +5899,13 @@ paths: description: Returns an email address. operationId: getEmail parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: email_id + - description: Email address ID. in: path name: email_id required: true @@ -5906,7 +5931,7 @@ paths: description: Gets the operator's individual information. operationId: getIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5922,7 +5947,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get individual information. + summary: Get individual information tags: - Operator x-soracom-cli: @@ -5931,7 +5956,7 @@ paths: description: Creates the operator's individual information. operationId: createIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5942,7 +5967,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: Model. required: true responses: "201": @@ -5950,7 +5975,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create individual information. + summary: Create individual information tags: - Operator x-soracom-cli: @@ -5959,7 +5984,7 @@ paths: description: Updates the operator's individual information. operationId: updateIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5970,7 +5995,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: Model. required: true responses: "200": @@ -5978,7 +6003,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update individual information. + summary: Update individual information tags: - Operator x-soracom-cli: @@ -5988,7 +6013,7 @@ paths: description: Revokes operator's MFA without backup codes. operationId: revokeMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6002,24 +6027,23 @@ paths: required: true responses: "204": - description: Revoked + description: Revoked. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Revoke Operator's MFA. + summary: Revoke Operator's MFA tags: - Operator x-soracom-cli: - operator revoke-mfa get: - description: |- - Gets operator's MFA status. The MFA status is one of `ACTIVE`, + description: Gets operator's MFA status. The MFA status is one of `ACTIVE`, `INACTIVE` or `UNCONFIRMED`. operationId: getMFAStatus parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6031,23 +6055,23 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAStatusOfUseResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get Operator's MFA Status. + summary: Get Operator's MFA Status tags: - Operator x-soracom-cli: - operator get-mfa-status post: - description: Enables operator's MFA. After calling this APIg, it should be verified + description: Enables operator's MFA. After calling this API, it should be verified by calling `Operator:verifyMFA` API. operationId: enableMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6059,26 +6083,26 @@ paths: application/json: schema: $ref: '#/components/schemas/EnableMFAOTPResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Enable Operator's MFA. + summary: Enable Operator's MFA tags: - Operator x-soracom-cli: - operator enable-mfa /operators/{operator_id}/mfa/verify: post: - description: Verifies operator's MFA with OTP code after calling `Operator:enableMFA` - API. MFA will not be activated unless the MFA OTP is verified with this API. Backup - codes are going to be returned in the response. These codes must be securely - stored. + description: Verifies operator's MFA with OTP code. This API must be called + after calling `Operator:enableMFA`. MFA will not be activated unless the MFA + OTP is verified with this API. Be sure to securely store the backup code returned + in the response to this API. operationId: verifyMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6089,7 +6113,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAAuthenticationRequest' - description: request + description: Request. required: true responses: "200": @@ -6097,13 +6121,13 @@ paths: application/json: schema: $ref: '#/components/schemas/OperatorMFAVerifyingResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Verify Operator's MFA OTP Code. + summary: Verify Operator's MFA OTP Code tags: - Operator x-soracom-cli: @@ -6113,7 +6137,7 @@ paths: description: Updates the operator's password. operationId: updateOperatorPassword parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6124,7 +6148,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePasswordRequest' - description: current password, new password + description: current password, new password. required: true responses: "200": @@ -6134,7 +6158,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Operator Password. + summary: Update Operator Password tags: - Operator x-soracom-cli: @@ -6144,7 +6168,7 @@ paths: description: Returns a list of roles. operationId: listRoles parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6162,7 +6186,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Roles. + summary: List Roles tags: - Role x-soracom-cli: @@ -6172,13 +6196,13 @@ paths: description: Deletes a role. operationId: deleteRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6194,7 +6218,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Role. + summary: Delete Role tags: - Role x-soracom-cli: @@ -6203,13 +6227,13 @@ paths: description: Retrieves a role. operationId: getRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6227,7 +6251,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Role. + summary: Get Role tags: - Role x-soracom-cli: @@ -6236,13 +6260,13 @@ paths: description: Adds a new role. operationId: createRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6253,7 +6277,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: Permission. required: true responses: "200": @@ -6267,7 +6291,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create Role. + summary: Create Role tags: - Role x-soracom-cli: @@ -6276,13 +6300,13 @@ paths: description: Edits a role. operationId: updateRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6293,17 +6317,17 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: Permission. required: true responses: "200": - description: OK + description: OK. "404": description: Role not found. security: - api_key: [] api_token: [] - summary: Update Role. + summary: Update Role tags: - Role x-soracom-cli: @@ -6313,13 +6337,13 @@ paths: description: Retrieves a list of users attached to a role. operationId: listRoleAttachedUsers parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6339,7 +6363,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Role Attached Users. + summary: List Role Attached Users tags: - Role x-soracom-cli: @@ -6349,7 +6373,7 @@ paths: description: Returns a list of shipping addresses. operationId: listShippingAddresses parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6365,7 +6389,7 @@ paths: security: - api_key: [] api_token: [] - summary: List shipping addresses. + summary: List shipping addresses tags: - ShippingAddress x-soracom-cli: @@ -6374,7 +6398,7 @@ paths: description: Creates a new shipping address. operationId: createShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6385,7 +6409,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: Shipping address. required: true responses: "201": @@ -6397,7 +6421,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create shipping address. + summary: Create shipping address tags: - ShippingAddress x-soracom-cli: @@ -6407,13 +6431,13 @@ paths: description: Deletes a shipping address. operationId: deleteShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6421,11 +6445,11 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Delete shipping address. + summary: Delete shipping address tags: - ShippingAddress x-soracom-cli: @@ -6434,13 +6458,13 @@ paths: description: Returns a shipping address. operationId: getShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6456,7 +6480,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get shipping address. + summary: Get shipping address tags: - ShippingAddress x-soracom-cli: @@ -6465,13 +6489,13 @@ paths: description: Updates a shipping address. operationId: updateShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6482,15 +6506,15 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: Shipping address. required: true responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Update shipping address. + summary: Update shipping address tags: - ShippingAddress x-soracom-cli: @@ -6500,7 +6524,7 @@ paths: description: Returns a token for accessing the support console. operationId: generateSupportToken parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6514,20 +6538,20 @@ paths: $ref: '#/components/schemas/SupportTokenResponse' description: OK. "400": - description: Invalid Operator Id + description: Invalid Operator Id. "403": description: Invalid token. security: - api_key: [] api_token: [] - summary: Generate Token for Support Console. + summary: Generate Token for Support Console tags: - Operator x-soracom-cli: - operator get-support-token /operators/{operator_id}/system_notifications: get: - description: Returns a list of system notifications. + description: Returns a list of email settings. operationId: listSystemNotifications parameters: - description: Operator ID @@ -6548,23 +6572,23 @@ paths: security: - api_key: [] api_token: [] - summary: List system notifications + summary: List email settings tags: - SystemNotification x-soracom-cli: - system-notifications list /operators/{operator_id}/system_notifications/{type}: delete: - description: Deletes a system notification. + description: Delete an email address from the email settings. operationId: deleteSystemNotification parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6576,26 +6600,26 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Delete system notification + summary: Delete an email address from the email settings tags: - SystemNotification x-soracom-cli: - system-notifications delete get: - description: Returns a system notification. + description: Return information on email settings. operationId: getSystemNotification parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6616,13 +6640,13 @@ paths: security: - api_key: [] api_token: [] - summary: Get system notification + summary: Get information on email settings tags: - SystemNotification x-soracom-cli: - system-notifications get post: - description: Sets a system notification. + description: Set an email address in the email settings. operationId: setSystemNotification parameters: - description: Operator ID @@ -6631,7 +6655,7 @@ paths: required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6647,7 +6671,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetSystemNotificationsRequest' - description: request + description: Request. required: true responses: "200": @@ -6655,11 +6679,11 @@ paths: application/json: schema: $ref: '#/components/schemas/SystemNotificationsModel' - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Set system notification + summary: Set an email address in the email settings tags: - SystemNotification x-soracom-cli: @@ -6671,7 +6695,7 @@ paths: new API token. You can then use the new API token in future requests. operationId: generateAuthToken parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6682,7 +6706,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GenerateTokenRequest' - description: token timeout seconds + description: Token timeout seconds. required: true responses: "200": @@ -6702,7 +6726,7 @@ paths: security: - api_key: [] api_token: [] - summary: Generate Authentication Token. + summary: Generate API Token tags: - Operator x-soracom-cli: @@ -6710,11 +6734,11 @@ paths: /operators/{operator_id}/tokens: delete: description: Revoke all API keys and API tokens that were generated by the root - user. Once revoked, the API key and API token cannot be used to call the SORACOM + user. Once revoked, the API key and API token cannot be used to call the Soracom API, regardless of their expiration time. operationId: revokeOperatorAuthTokens parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6724,12 +6748,12 @@ paths: "204": description: Successfully revoked all API keys and API tokens. "400": - description: Wrong operator ID was specified. + description: Invalid Operator Id. security: - api_key: [] api_token: [] summary: Revoke all API keys and API tokens that were generated by the root - user. + user tags: - Operator x-soracom-cli: @@ -7411,13 +7435,13 @@ paths: description: Retrieves a list of the user's roles. operationId: listUserRoles parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true @@ -7437,7 +7461,7 @@ paths: security: - api_key: [] api_token: [] - summary: List User Roles. + summary: List User Roles tags: - Role x-soracom-cli: @@ -7446,13 +7470,13 @@ paths: description: Attaches a role to a user. operationId: attachRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true @@ -7463,11 +7487,11 @@ paths: application/json: schema: $ref: '#/components/schemas/AttachRoleRequest' - description: role_id + description: Role ID. required: true responses: "200": - description: OK + description: OK. "400": description: The role has already been attached or not found. "404": @@ -7475,7 +7499,7 @@ paths: security: - api_key: [] api_token: [] - summary: Attach Role to User. + summary: Attach Role to User tags: - Role x-soracom-cli: @@ -7485,19 +7509,19 @@ paths: description: Detaches a role from a user. operationId: detachRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -7505,13 +7529,13 @@ paths: type: string responses: "200": - description: OK + description: OK. "404": description: SAM user or role not found. security: - api_key: [] api_token: [] - summary: Detach Role from User. + summary: Detach Role from User tags: - Role x-soracom-cli: @@ -7554,7 +7578,7 @@ paths: description: Deletes user trust policy for switching user. operationId: deleteUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7583,7 +7607,7 @@ paths: description: Gets user trust policy for switching user. operationId: getUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7619,7 +7643,7 @@ paths: **Warning**: Setting a trust policy will allow the operator(s) or user(s) specified in the request body to switch to this SAM user. When switching, the trusted operator(s) or user(s) will be granted the same permissions as this SAM user, and may be able to see session history, traffic history, and other account information. operationId: updateUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7646,7 +7670,7 @@ paths: security: - api_key: [] api_token: [] - summary: Updates user trust policy. + summary: Updates user trust policy tags: - User x-soracom-cli: @@ -7743,18 +7767,18 @@ paths: - users default-permissions update /operators/add_email_token/issue: post: - description: Sends an email with a one-time token for adding an e-mail address. + description: Sends an email with a one-time token for adding an email address. operationId: issueAddEmailToken requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueAddEmailTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": description: Exceeds maximum number of emails. security: @@ -7774,11 +7798,11 @@ paths: application/json: schema: $ref: '#/components/schemas/VerifyAddEmailTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. summary: Verify a token to add an email address tags: - Email @@ -7794,16 +7818,16 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAIssueRevokingTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. "404": - description: Operator not found - summary: Issue Operator's MFA Revoke Token. + description: Operator not found. + summary: Issue Operator's MFA Revoke Token tags: - Operator x-soracom-cli: @@ -7819,50 +7843,26 @@ paths: application/json: schema: $ref: '#/components/schemas/MFARevokingTokenVerifyRequest' - description: request + description: Request. required: true responses: "200": - description: Revoked + description: Revoked. "400": - description: Bad request + description: Bad request. "403": - description: Invalid username or password - summary: Verify Operator's MFA revoke token. + description: Invalid username or password. + summary: Verify Operator's MFA revoke token tags: - Operator x-soracom-cli: - operator verify-mfa-revoke-token - /operators/verify: - post: - description: Verifies the operator's registration. Called by setting as parameter - the one-time verification token received via e-mail. - operationId: verifyOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VerifyOperatorsRequest' - description: token - required: true - responses: - "200": - description: Registration successful. - "400": - description: The one-time token is incorrect. - "404": - description: The one-time token has expired. - summary: Verify Operator. - tags: - - Operator - x-soracom-cli: - - operator verify /orders: get: description: | Get a list of confirmed order history. - **Warning**: You can only obtain order history for the past 18 months. If you need the order history before that time, please contact [SORACOM Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listOrders responses: "200": @@ -7874,13 +7874,13 @@ paths: security: - api_key: [] api_token: [] - summary: Get a list of confirmed order history. + summary: Get a list of confirmed order history tags: - Order x-soracom-cli: - orders list post: - description: Creates a new order quotation. If the orderId is put in /confirm, + description: Creates a new order quotation. If the orderId is put in /orders/{order_id}/confirm, the order is complete. operationId: createQuotation requestBody: @@ -7888,7 +7888,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEstimatedOrderRequest' - description: Order item list and shipping address ID + description: Order item list and shipping address ID. required: true responses: "201": @@ -7900,7 +7900,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create Quotation. + summary: Create Quotation tags: - Order x-soracom-cli: @@ -7910,10 +7910,10 @@ paths: description: | Returns a confirmed order. - **Warning**: You can only obtain a confirmed order for the past 18 months. If you need the confirmed order before that time, please contact [SORACOM Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7929,7 +7929,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get a confirmed order. + summary: Get a confirmed order tags: - Order x-soracom-cli: @@ -7940,7 +7940,7 @@ paths: error is returned. operationId: cancelOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7956,18 +7956,20 @@ paths: security: - api_key: [] api_token: [] - summary: Cancel order. + summary: Cancel order tags: - Order x-soracom-cli: - orders cancel /orders/{order_id}/confirm: put: - description: Performs a credit limit and confirms the order if no problems are - encountered. + description: | + Performs a credit limit and confirms the order if no problems are encountered. + + **Warning**: Only orders completed within the past month can be confirmed. If one month has elapsed, please redo the order placement operation. operationId: confirmOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7979,17 +7981,20 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm order. + summary: Confirm order tags: - Order x-soracom-cli: - orders confirm /orders/{order_id}/resource_initial_setting: put: - description: Update resource initial setting for an order + description: | + Update resource initial setting for an order. + + **Warning**: Initial settings of IoT SIM cannot be specified after confirmation of receipt. operationId: updateOrderedResourceInitialSetting parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -8000,7 +8005,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ResourceInitialSetting' - description: Resource initial setting for an order + description: Resource initial setting for an order. required: true responses: "200": @@ -8016,24 +8021,28 @@ paths: security: - api_key: [] api_token: [] - summary: Update resource initial setting for an order. + summary: Update resource initial setting for an order tags: - Order x-soracom-cli: - orders resource-initial-setting update /orders/{order_id}/subscribers: get: - description: List ordered subscribers + description: | + List ordered subscribers. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listOrderedSubscribers parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true schema: type: string - - description: Serial number of the last subscriber in the previous page that - is set to response header with X-Soracom-Next-Key. + - description: The value of the `x-soracom-next-key` header returned when the + previous page was retrieved. Specify if the next page is to be retrieved. + For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination). in: query name: last_evaluated_key required: false @@ -8056,7 +8065,7 @@ paths: security: - api_key: [] api_token: [] - summary: List ordered subscribers. + summary: List ordered subscribers tags: - Order x-soracom-cli: @@ -8068,10 +8077,13 @@ paths: header: x-soracom-next-key /orders/{order_id}/subscribers/register: post: - description: Registers the ordered SIM with the operator. + description: | + Registers the ordered SIM with the operator. + + **Warning**: IoT SIMs can only be registered for the past 18 months. If you need to register an IoT SIM that was ordered before the time period, please contact [Soracom Support](https://support.soracom.io). operationId: registerOrderedSim parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -8087,18 +8099,21 @@ paths: security: - api_key: [] api_token: [] - summary: Register subscribers for operator. + summary: Register subscribers for operator tags: - Order x-soracom-cli: - orders register-subscribers /payment_history/transactions/{payment_transaction_id}: get: - description: Returns result of a payment transaction. + description: | + Returns result of a payment transaction. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getPaymentTransaction parameters: - description: Payment transaction ID. It can be obtained via [Billing:getBillingHistory - API](#/Billing/getBillingHistory) or [Billing:getBilling API](#/Billing/getBilling). + API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling). in: path name: payment_transaction_id required: true @@ -8140,7 +8155,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get payment method information. + summary: Get current payment method information. tags: - Payment x-soracom-cli: @@ -8161,14 +8176,17 @@ paths: security: - api_key: [] api_token: [] - summary: Activate payment method. + summary: Activate current payment method tags: - Payment x-soracom-cli: - payment-methods reactivate-current /payment_statements: get: - description: List payment statements. + description: | + List payment statements. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listPaymentStatements responses: "200": @@ -8180,14 +8198,17 @@ paths: security: - api_key: [] api_token: [] - summary: List payment statements. + summary: List payment statements tags: - Payment x-soracom-cli: - payment-statements list /payment_statements/{payment_statement_id}/export: post: - description: Export payment statement. + description: | + Export payment statement. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: exportPaymentStatement parameters: - description: Payment statement ID @@ -8217,7 +8238,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export payment statement. + summary: Export payment statement tags: - Payment x-soracom-cli: @@ -8238,7 +8259,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export payer information. + summary: Export payer information tags: - Payment x-soracom-cli: @@ -8251,7 +8272,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RegisterPayerInformationModel' - description: Payer information to be registered in the accounting specification + description: Payer information to be registered in the accounting specification. required: true responses: "201": @@ -8261,7 +8282,7 @@ paths: security: - api_key: [] api_token: [] - summary: Register payer information. + summary: Register payer information tags: - Payment x-soracom-cli: @@ -8277,8 +8298,8 @@ paths: required: false schema: type: integer - - description: The last Port Mapping ID retrieved on the current page. By specifying - this parameter, you can continue to retrieve the list from the next group + - description: The last Port Mapping ID retrieved on the previous page. By specifying + this parameter, you can continue to retrieve the list from the next entry onward. in: query name: last_evaluated_key @@ -8297,7 +8318,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Port Mapping Entries. + summary: List Port Mapping Entries tags: - PortMapping x-soracom-cli: @@ -8323,27 +8344,27 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Port Mapping. + summary: Create Port Mapping tags: - PortMapping x-soracom-cli: - port-mappings create /port_mappings/{ip_address}/{port}: delete: - description: Deletes the specified port mapping entry + description: Deletes the specified port mapping entry. operationId: deletePortMapping parameters: - - description: IP address of the target port mapping entry + - description: IP address of the target port mapping entry. in: path name: ip_address required: true schema: type: string - - description: Port of the target port mapping entry + - description: Port of the target port mapping entry. in: path name: port required: true @@ -8357,7 +8378,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete PortMapping. + summary: Delete Port Mapping tags: - PortMapping x-soracom-cli: @@ -8367,7 +8388,7 @@ paths: description: Returns the port mapping entries for a subscriber. operationId: listPortMappingsForSubscriber parameters: - - description: Target subscriber IMSI. + - description: IMSI of the target subscriber. in: path name: imsi required: true @@ -8385,7 +8406,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Port Mapping entries for a subscriber. + summary: Get Port Mapping entries for a subscriber tags: - PortMapping x-soracom-cli: @@ -8394,6 +8415,12 @@ paths: get: description: Returns a list of products. operationId: listProducts + parameters: + - in: query + name: campaign_code + required: false + schema: + type: string responses: "200": content: @@ -8404,7 +8431,7 @@ paths: security: - api_key: [] api_token: [] - summary: List products. + summary: List products tags: - Order x-soracom-cli: @@ -8417,7 +8444,7 @@ paths: information. operationId: searchDevices parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8426,7 +8453,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8435,7 +8462,7 @@ paths: items: type: string type: array - - description: SORACOM Inventory device ID to search + - description: SORACOM Inventory device ID to search. explode: true in: query name: deviceId @@ -8444,7 +8471,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8453,7 +8480,7 @@ paths: items: type: string type: array - - description: IMSI of the device that was used on bootstrapping + - description: IMSI of the device that was used on bootstrapping. explode: true in: query name: imsi @@ -8462,7 +8489,7 @@ paths: items: type: string type: array - - description: IMEI of the device that was used on bootstrapping + - description: IMEI of the device that was used on bootstrapping. explode: true in: query name: imei @@ -8471,7 +8498,7 @@ paths: items: type: string type: array - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8481,14 +8508,14 @@ paths: maximum: 100 type: integer - description: The SORACOM Inventory device ID of the last Inventory device - retrieved on the current page. By specifying this parameter, you can continue + retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward. in: query name: last_evaluated_key required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8506,9 +8533,9 @@ paths: items: $ref: '#/components/schemas/Device' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8529,7 +8556,7 @@ paths: and retrieve all Sigfox devices that includes their group information. operationId: searchSigfoxDevices parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8538,7 +8565,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8547,7 +8574,7 @@ paths: items: type: string type: array - - description: Sigfox device ID to search + - description: Sigfox device ID to search. explode: true in: query name: deviceId @@ -8556,7 +8583,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8565,7 +8592,7 @@ paths: items: type: string type: array - - description: Status of sigfox devices + - description: Status of sigfox devices. in: query name: status required: false @@ -8582,7 +8609,7 @@ paths: - banned - standby type: string - - description: Registration status of sigfox devices + - description: Registration status of sigfox devices. in: query name: registration required: false @@ -8594,7 +8621,7 @@ paths: - success - failed type: string - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8604,14 +8631,14 @@ paths: maximum: 100 type: integer - description: The Sigfox device ID of the last Sigfox device retrieved on the - current page. By specifying this parameter, you can continue to retrieve + previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward. in: query name: last_evaluated_key required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8629,9 +8656,9 @@ paths: items: $ref: '#/components/schemas/SigfoxDevice' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8647,12 +8674,13 @@ paths: header: x-soracom-next-key /query/sims: get: - description: Search SIMs by query terms. It returns partial match results. When - this API permission is allowed, it grants the authority to search and retrieve - all SIMs that includes their group information. + description: | + Search SIMs by query terms. It returns partial match results. It is case-insensitive. + + **Warning**: When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information. operationId: searchSims parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8661,7 +8689,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8670,7 +8698,7 @@ paths: items: type: string type: array - - description: Identifier of the SIM to search + - description: Identifier of the SIM to search. explode: true in: query name: sim_id @@ -8679,7 +8707,7 @@ paths: items: type: string type: array - - description: IMSI to search + - description: IMSI to search. explode: true in: query name: imsi @@ -8688,7 +8716,7 @@ paths: items: type: string type: array - - description: MSISDN to search + - description: MSISDN to search. explode: true in: query name: msisdn @@ -8697,7 +8725,8 @@ paths: items: type: string type: array - - description: ICCID to search + - description: ICCID to search. An identifier to identify a SIM card or virtual + IoT SIM (Virtual SIM/Subscriber). explode: true in: query name: iccid @@ -8706,7 +8735,8 @@ paths: items: type: string type: array - - description: Serial number to search + - description: Serial number to search. This is set only for IoT SIMs for specific + regions. explode: true in: query name: serial_number @@ -8715,7 +8745,8 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. For more information, please + refer to [Using Tags with Soracom Air](/docs/air/tags). explode: true in: query name: tag @@ -8724,7 +8755,7 @@ paths: items: type: string type: array - - description: Bundles type to search + - description: Bundles type to search. explode: true in: query name: bundles @@ -8733,7 +8764,12 @@ paths: items: type: string type: array - - description: Status of the session to search (ONLINE or OFFLINE) + - description: | + Status of the session to search (ONLINE or OFFLINE). + + - `NA`: Any. + - `ONLINE`: Online. + - `OFFLINE`: Offline. in: query name: session_status required: false @@ -8745,7 +8781,7 @@ paths: - OFFLINE format: string type: string - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8754,7 +8790,7 @@ paths: format: int32 maximum: 100 type: integer - - description: The SIM ID of the last SIM retrieved on the current page. By + - description: The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward. in: query @@ -8762,7 +8798,8 @@ paths: required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). If omitted, + it is an AND search. in: query name: search_type required: false @@ -8780,9 +8817,9 @@ paths: items: $ref: '#/components/schemas/Sim' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8799,13 +8836,13 @@ paths: /query/subscribers: get: deprecated: true - description: '(DEPRECATED: please consider to use `/query/sims` API instead) - Search subscribers by query terms. It returns partial match results. When + description: '(DEPRECATED: please consider to use `/query/sims` API instead + ) Search subscribers by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information.' operationId: searchSubscribers parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8814,7 +8851,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8823,7 +8860,7 @@ paths: items: type: string type: array - - description: IMSI to search + - description: IMSI to search. explode: true in: query name: imsi @@ -8832,7 +8869,7 @@ paths: items: type: string type: array - - description: MSISDN to search + - description: MSISDN to search. explode: true in: query name: msisdn @@ -8841,7 +8878,7 @@ paths: items: type: string type: array - - description: ICCID to search + - description: ICCID to search. explode: true in: query name: iccid @@ -8850,7 +8887,7 @@ paths: items: type: string type: array - - description: Serial number to search + - description: Serial number to search. explode: true in: query name: serial_number @@ -8859,7 +8896,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8868,7 +8905,7 @@ paths: items: type: string type: array - - description: Subscription (e.g. `plan01s`) to search + - description: Subscription (e.g. `plan01s`) to search. explode: true in: query name: subscription @@ -8877,7 +8914,7 @@ paths: items: type: string type: array - - description: Module type (e.g. `mini`, `virtual`) to search + - description: Module type (e.g. `mini`, `virtual`) to search. explode: true in: query name: module_type @@ -8886,7 +8923,7 @@ paths: items: type: string type: array - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8895,7 +8932,7 @@ paths: format: int32 maximum: 100 type: integer - - description: The IMSI of the last subscriber retrieved on the current page. + - description: The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward. in: query @@ -8903,7 +8940,7 @@ paths: required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8921,9 +8958,9 @@ paths: items: $ref: '#/components/schemas/Subscriber' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8940,24 +8977,24 @@ paths: header: x-soracom-next-key /query/subscribers/traffic_volume/ranking: get: - description: Search traffic volume ranking of subscribers + description: Search traffic volume ranking of subscribers. operationId: searchSubscriberTrafficVolumeRanking parameters: - - description: 'The beginning point of searching range (unixtime: in milliseconds)' + - description: The beginning point of searching range (UNIX time in milliseconds). in: query name: from required: true schema: format: int64 type: integer - - description: 'The end point of searching range (unixtime: in milliseconds)' + - description: The end point of searching range (UNIX time in milliseconds). in: query name: to required: true schema: format: int64 type: integer - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8966,7 +9003,7 @@ paths: format: int32 maximum: 500 type: integer - - description: The order of ranking + - description: The order of ranking. in: query name: order required: false @@ -8984,7 +9021,7 @@ paths: items: $ref: '#/components/schemas/TrafficVolumeRanking' type: array - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -9002,7 +9039,7 @@ paths: - description: | The type of the resource summary. - - `simsPerStatus`: The number of IoT SIMs per status + - `simsPerStatus`: The number of IoT SIMs per status. in: path name: resource_summary_type required: true @@ -9022,7 +9059,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get the resource summary identified by resource_summary_type. + summary: Get the resource summary identified by resource_summary_type tags: - ResourceSummary x-soracom-cli: @@ -9155,11 +9192,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -9747,11 +9787,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward. @@ -10032,7 +10075,7 @@ paths: security: - api_key: [] api_token: [] - summary: Lists packet capture sessions associated with the SIM. + summary: Lists packet capture sessions associated with the SIM tags: - Sim x-soracom-cli: @@ -10046,7 +10089,7 @@ paths: description: Creates a packet capture session associated with the SIM. operationId: createSimPacketCaptureSession parameters: - - description: The SIM ID for which a packet capture session is created + - description: SIM ID of the target SIM. in: path name: sim_id required: true @@ -10065,7 +10108,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Created a new packet capture session associated with the SIM + description: The packet capture session associated with the SIM "400": description: Failed to create a packet capture session for the specified SIM @@ -10074,14 +10117,14 @@ paths: security: - api_key: [] api_token: [] - summary: Creates a packet capture session associated with the SIM. + summary: Creates a packet capture session associated with the SIM tags: - Sim x-soracom-cli: - sims create-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}: delete: - description: Deletes a packet capture session associated with the SIM + description: Deletes a packet capture session associated with the SIM. operationId: deleteSimPacketCaptureSession parameters: - description: SIM ID of the target SIM. @@ -10102,7 +10145,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Deleted the packet capture session associated with the SIM + description: Deleted the packet capture session "400": description: Failed to delete the packet capture session associated with the SIM @@ -10118,7 +10161,7 @@ paths: x-soracom-cli: - sims delete-packet-capture-session get: - description: Gets a packet capture session associated the SIM + description: Gets a packet capture session associated with the SIM. operationId: getSimPacketCaptureSession parameters: - description: SIM ID of the target SIM. @@ -10146,7 +10189,7 @@ paths: security: - api_key: [] api_token: [] - summary: Gets a packet capture session associated the SIM + summary: Gets a packet capture session associated with the SIM tags: - Sim x-soracom-cli: @@ -10174,7 +10217,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: The stopped packet capture session associated with the SIM + description: The stopped packet capture session "400": description: The packet capture session can be stopped only when its status is CAPTURING @@ -10186,7 +10229,7 @@ paths: security: - api_key: [] api_token: [] - summary: Stops a SIM packet capture session + summary: Stops a packet capture session associated with the SIM tags: - Sim x-soracom-cli: @@ -10654,6 +10697,94 @@ paths: - Sim x-soracom-cli: - sims set-to-standby + /sims/{sim_id}/statuses/history: + get: + description: List IoT SIM status operation history. Status operation history + entry records what status operations were performed for which IMSI and which + subscriptions, along with the operation time. It includes speed class, group + ID, IoT SIM status, etc. If the total number of status operation history entry + does not fit in one page, a URL for accessing the next page is returned in + the 'link' header of the response. + operationId: listSimStatusHistory + parameters: + - description: SIM ID of the target SIM. + in: path + name: sim_id + required: true + schema: + type: string + - description: Start time of the status operation history entry to be searched + (UNIX time in milliseconds). If not specified, `from` is set to the oldest + status operation history entry time of the target IoT SIM. + in: query + name: from + required: false + schema: + type: integer + - description: End time of the status operation history entry to be searched + (UNIX time in milliseconds). If not specified, `to` is set to the current + time. + in: query + name: to + required: false + schema: + type: integer + - description: A string consisting of the primary IMSI and the timestamp (UNIX + time in milliseconds) of the last status operation history entry obtained + on the previous page, concatenated with `@`. By specifying this parameter, + you can continue to retrieve the list from the next page onward. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Sort order of status operation history entry. Either descending + (latest data entry first) or ascending (oldest data entry first). + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + - description: Maximum number of items to retrieve in one request. The response + may contain fewer items than the specified limit. + in: query + name: limit + required: false + schema: + default: 30 + maximum: 100 + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SimStatusHistoryResponse' + type: array + description: A list of status operation history entry of the IoT SIM. + "400": + description: Bad request. + "404": + description: No such SIM found. + security: + - api_key: [] + api_token: [] + summary: List IoT SIM status operation history + tags: + - Sim + x-soracom-cli: + - sims list-status-history + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sims/{sim_id}/suspend: post: description: Changes status of specified SIM to "suspended". @@ -10906,9 +11037,9 @@ paths: /sora_cam/devices: get: description: | - Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services. You can also retrieve information on cameras for which a license has not been assigned. + Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDevices responses: "200": @@ -10944,7 +11075,7 @@ paths: description: | Obtain a SoraCam device record for the device identified by device_id. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDevice parameters: - description: Device ID of the target compatible camera device. @@ -10985,110 +11116,56 @@ paths: - SoraCam x-soracom-cli: - sora-cam devices get - /sora_cam/devices/{device_id}/events: + /sora_cam/devices/{device_id}/atomcam/settings: get: description: | - Returns list of SoraCam events for the specified device. - operationId: listSoraCamDeviceEventsForDevice + Retrieve the camera's various settings. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettings parameters: - - description: ID of the target SoraCam device. + - description: Device ID of the target compatible camera device. in: path name: device_id required: true schema: type: string - - description: Value of the x-soracom-next-key header in the response to the - last listSoraCamDeviceEventsForDevice request. By specifying this parameter, - you can continue to retrieve the list from the last request. - in: query - name: last_evaluated_key - required: false - schema: - type: string - - description: Maximum number of items to retrieve in one request. Note that - the response may contain fewer items than the specified limit. - in: query - name: limit - required: false - schema: - default: 10 - type: integer - - description: Start time of the events to be searched (unix time in milliseconds). - If not specified, `from` is set to the oldest event time. - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: End time of the events to be searched (unix time in milliseconds). - If not specified, `to` is set to the current time. - in: query - name: to - required: false - schema: - format: int64 - type: integer - - description: | - Sort order of the events. - - - `desc`: Descending order (latest data entry first) - - `asc`: Ascending order (oldest data entry first) - in: query - name: sort - required: false - schema: - default: desc - enum: - - desc - - asc - type: string responses: "200": content: application/json: example: - - deviceId: 7CDDDEADBEEF - deviceType: atomCamV2 - eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b - eventInfo: - endTime: 1662973203000 - picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... - recordingStatus: completed - startTime: 1662973200000 - type: motion - time: 1662973200000 - schema: - items: - $ref: '#/components/schemas/SoraCamEvent' - type: array + logo: "on" + motionTagging: "on" + nightVision: auto + quality: high + rotation: 0 + statusLight: "on" + timestamp: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettings' description: OK. - "400": - description: The specified argument is invalid. "404": - description: The specified SoraCam device could not be found. + description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: List SoraCam events for the specified device. + summary: Retrieve the camera's various settings tags: - SoraCam x-soracom-cli: - - sora-cam devices events list-for-device - x-soracom-cli-pagination: - request: - param: last_evaluated_key - response: - header: x-soracom-next-key - /sora_cam/devices/{device_id}/exports/usage: + - sora-cam devices atomcam get-settings + /sora_cam/devices/{device_id}/atomcam/settings/logo: get: description: | - Get the remaining number of still images that can be exported and the remaining exportable time of recorded video. + Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. - **Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: getSoraCamDeviceExportUsage + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsLogo parameters: - description: Device ID of the target compatible camera device. in: path @@ -11101,39 +11178,29 @@ paths: content: application/json: example: - deviceId: 7CDDDEADBEEF - image: - billedFrames: 0 - limitFrames: 259200 - remainingFrames: 259131 - usedFrames: 69 - meteredYearMonth: "202209" - video: - billedSeconds: 0 - limitSeconds: 259200 - remainingSeconds: 259131 - usedSeconds: 69 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsage' + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' description: OK. "404": description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: Get the remaining number of still images that can be exported and the - remaining exportable time of recorded video. + summary: Retrieve the display settings for the ATOM tech Inc. logo shown on + the bottom left of the captured image tags: - SoraCam x-soracom-cli: - - sora-cam devices get-export-usage - /sora_cam/devices/{device_id}/exports/usage/limit_override: - delete: + - sora-cam devices atomcam settings get-logo + post: description: | - Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month. + Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: deleteSoraCamDeviceExportUsageLimitOverride + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsLogo parameters: - description: Device ID of the target compatible camera device. in: path @@ -11141,30 +11208,38 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' responses: - "204": - description: OK, deleted. + "200": + description: OK. + "400": + description: The specified value is invalid. "404": description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: Reset the monthly limit on the recorded video time available for export - for compatible camera device to the default value. + summary: Change the display settings for the ATOM tech Inc. logo shown on the + bottom left of the captured image tags: - SoraCam x-soracom-cli: - - sora-cam devices delete-export-usage-limit-override - put: + - sora-cam devices atomcam settings set-logo + /sora_cam/devices/{device_id}/atomcam/settings/motion_tagging: + get: description: | - Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set. + Retrieve the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. - **Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Services [about fees](https://soracom.jp/sora_cam/#pricing) (Japanese). - - **Warning**: The monthly limit can be set to less than 72 hours. In such cases, there will be no change in the charge. + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: updateSoraCamDeviceExportUsageLimitOverride + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsMotionTagging parameters: - description: Device ID of the target compatible camera device. in: path @@ -11172,9 +11247,618 @@ paths: required: true schema: type: string - requestBody: - content: - application/json: + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the display settings for motion tagging + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-motion-tagging + post: + description: | + Change the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsMotionTagging + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the display settings for motion tagging + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-motion-tagging + /sora_cam/devices/{device_id}/atomcam/settings/night_vision: + get: + description: | + Retrieve the settings for night vision mode. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for night vision mode + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-night-vision + post: + description: | + Change the settings for night vision mode. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for night vision mode + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-night-vision + /sora_cam/devices/{device_id}/atomcam/settings/quality: + get: + description: | + Retrieve the quality settings for cloud recording. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the quality settings for cloud recording + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-quality + post: + description: | + Change the quality settings for cloud recording. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the quality settings for cloud recording + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-quality + /sora_cam/devices/{device_id}/atomcam/settings/rotation: + get: + description: | + Retrieve the settings for rotating the image by 180 degrees. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for rotating the image by 180 degrees + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-rotation + post: + description: | + Change the settings for rotating the image by 180 degrees. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for rotating the image by 180 degrees + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-rotation + /sora_cam/devices/{device_id}/atomcam/settings/status_light: + get: + description: | + Retrieve the settings for the status light (indicator light that shows the status of the camera). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for the status light (indicator light that shows + the status of the camera) + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-status-light + post: + description: | + Change the settings for the status light (indicator light that shows the status of the camera). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for the status light (indicator light that shows + the status of the camera) + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-status-light + /sora_cam/devices/{device_id}/atomcam/settings/timestamp: + get: + description: | + Retrieve the display settings for the timestamp shown on the bottom right of the captured image. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the display settings for the timestamp shown on the bottom + right of the captured image + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-timestamp + post: + description: | + Change the display settings for the timestamp shown on the bottom right of the captured image. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the display settings for the timestamp shown on the bottom right + of the captured image + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-timestamp + /sora_cam/devices/{device_id}/events: + get: + description: | + Returns list of SoraCam events for the specified device. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: listSoraCamDeviceEventsForDevice + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + - description: Value of the x-soracom-next-key header in the response to the + last listSoraCamDeviceEventsForDevice request. By specifying this parameter, + you can continue to retrieve the list from the last request. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Maximum number of items to retrieve in one request. Note that + the response may contain fewer items than the specified limit. + in: query + name: limit + required: false + schema: + default: 10 + type: integer + - description: Start time of the events to be searched (unix time in milliseconds). + If not specified, `from` is set to the oldest event time. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: End time of the events to be searched (unix time in milliseconds). + If not specified, `to` is set to the current time. + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + Sort order of the events. + + - `desc`: Descending order (latest data entry first) + - `asc`: Ascending order (oldest data entry first) + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + responses: + "200": + content: + application/json: + example: + - deviceId: 7CDDDEADBEEF + deviceType: atomCamV2 + eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b + eventInfo: + endTime: 1662973203000 + picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... + recordingStatus: completed + startTime: 1662973200000 + type: motion + time: 1662973200000 + schema: + items: + $ref: '#/components/schemas/SoraCamEvent' + type: array + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: List SoraCam events for the specified device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key + /sora_cam/devices/{device_id}/exports/usage: + get: + description: | + Get the remaining number of still images that can be exported and the remaining exportable time of recorded video. + + **Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: getSoraCamDeviceExportUsage + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + deviceId: 7CDDDEADBEEF + image: + billedFrames: 0 + limitFrames: 259200 + remainingFrames: 259131 + usedFrames: 69 + meteredYearMonth: "202209" + video: + billedSeconds: 0 + limitSeconds: 259200 + remainingSeconds: 259131 + usedSeconds: 69 + schema: + $ref: '#/components/schemas/SoraCamExportUsage' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the remaining number of still images that can be exported and the + remaining exportable time of recorded video. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-export-usage + /sora_cam/devices/{device_id}/exports/usage/limit_override: + delete: + description: | + Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: deleteSoraCamDeviceExportUsageLimitOverride + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "204": + description: OK, deleted. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Reset the monthly limit on the recorded video time available for export + for compatible camera device to the default value. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices delete-export-usage-limit-override + put: + description: | + Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set. + + **Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Services [about fees](https://soracom.jp/sora_cam/#pricing) (Japanese). + + **Warning**: The monthly limit can be set to less than 72 hours. In such cases, there will be no change in the charge. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: updateSoraCamDeviceExportUsageLimitOverride + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: example: limitHours: 144 schema: @@ -11220,7 +11904,7 @@ paths: If the target is not limited to one compatible camera device, but all compatible camera device owned by the operator, use [SoraCam:listSoraCamDeviceImageExports API](#/SoraCam/listSoraCamDeviceImageExports). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceImageExportsForDevice parameters: - description: Device ID of the target compatible camera device. @@ -11343,7 +12027,7 @@ paths: **Warning**: Images from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection "Unlimited" Recording License cannot be exported. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: exportSoraCamDeviceRecordedImage parameters: - description: Device ID of the target compatible camera device. @@ -11393,7 +12077,7 @@ paths: description: | Gets the list of the current status of the process of exporting still image from recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one export process. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceExportedImage parameters: - description: Device ID of the target compatible camera device. @@ -11401,86 +12085,328 @@ paths: name: device_id required: true schema: - type: string - - description: Export ID of the target export operation. - in: path - name: export_id - required: true + type: string + - description: Export ID of the target export operation. + in: path + name: export_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + (1) Initializing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: initializing + (2) Processing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: processing + (3) Completed: + value: + - deviceId: 7CDDDEADBEEF + expiryTime: 1662973800000 + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: completed + url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... + (4) Retrying: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: retrying + (5) Failed: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: failed + (6) limitExceeded: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: limitExceeded + (7) Expired: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: expired + schema: + items: + $ref: '#/components/schemas/SoraCamImageExportInfo' + type: array + description: OK. + "404": + description: The specified compatible camera device or export process could + not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current status of the process of exporting still images from + recorded video taken with a compatible camera device + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images get-exported + /sora_cam/devices/{device_id}/name: + get: + description: Get the current name of the compatible camera device. + operationId: getSoraCamDeviceName + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current name of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-name + post: + description: Changes the name of the compatible camera device. + operationId: setSoraCamDeviceName + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Changes the name of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-name + /sora_cam/devices/{device_id}/power_state: + get: + description: Get the current power state of the compatible camera device. + operationId: getSoraCamDevicePowerState + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current power state of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-power-state + post: + description: Changes the power state of the compatible camera device. + operationId: setSoraCamDevicePowerState + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Changes the power state of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-power-state + /sora_cam/devices/{device_id}/reboot: + post: + description: Reboot the compatible camera device. + operationId: rebootSoraCamDevice + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Reboot the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices reboot + /sora_cam/devices/{device_id}/recordings_and_events: + get: + description: | + Returns a list of recording periods and events for a compatible camera device. + + **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: listSoraCamDeviceRecordingsAndEvents + parameters: + - description: Device ID of the compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + - description: Value of the x-soracom-next-key header in the response to the + last listSoraCamDeviceRecordingsAndEvents request. By specifying this parameter, + you can continue to retrieve the list from the last request. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Start time of the list to be searched (unix time in milliseconds). + If not specified, `from` is set to the oldest time within the retention + period of the license assigned to the compatible camera device. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: End time of the list to be searched (unix time in milliseconds). + If not specified, `to` is set to the current time. + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + Sort order of the recordings and events. + + - `desc`: Descending order (latest data entry first) + - `asc`: Ascending order (oldest data entry first) + in: query + name: sort + required: false schema: + default: desc + enum: + - desc + - asc type: string responses: "200": content: application/json: - examples: - (1) Initializing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: initializing - (2) Processing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: processing - (3) Completed: - value: - - deviceId: 7CDDDEADBEEF - expiryTime: 1662973800000 - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: completed - url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... - (4) Retrying: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: retrying - (5) Failed: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: failed - (6) limitExceeded: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: limitExceeded - (7) Expired: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: expired + example: + events: + - endTime: 1699318810000 + startTime: 1699318800000 + type: motion + - endTime: 1699320820000 + startTime: 1699320810000 + type: sound + - endTime: 1699315210000 + startTime: 1699315200000 + type: motion + records: + - startTime: 1699318800000 + - endTime: 1699318800000 + startTime: 169931520000011 schema: - items: - $ref: '#/components/schemas/SoraCamImageExportInfo' - type: array + $ref: '#/components/schemas/SoraCamRecordingsAndEventsList' description: OK. + "400": + description: The specified argument is invalid. "404": - description: The specified compatible camera device or export process could - not be found. + description: The specified compatible camera device, or the recordings for + the specified period, could not be found. security: - api_key: [] api_token: [] - summary: Get the current status of the process of exporting still images from - recorded video taken with a compatible camera device. + summary: Retrieve a list of recording periods and events for a compatible camera + device tags: - SoraCam x-soracom-cli: - - sora-cam devices images get-exported + - sora-cam devices recordings-and-events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sora_cam/devices/{device_id}/stream: get: description: | @@ -11495,7 +12421,7 @@ paths: **Warning**: Real-time video is a function that retrieves the latest video from recorded video saved on the cloud. Therefore, a Cloud Continuous Recording License or a Cloud Motion Detection "Unlimited" Recording License is required to obtain real-time video. **Live video (P2P)** that can be played on the ATOM app is a different feature from the real-time video. **Live video (P2P)** cannot be obtained using the SORACOM API. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceStreamingVideo parameters: - description: Device ID of the target compatible camera device. @@ -11557,7 +12483,7 @@ paths: If the target is not limited to one compatible camera device, but all compatible camera device owned by the operator, use [SoraCam:listSoraCamDeviceVideoExports API](#/SoraCam/listSoraCamDeviceVideoExports). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceVideoExportsForDevice parameters: - description: Device ID of the target compatible camera device. @@ -11681,7 +12607,7 @@ paths: **Warning**: Recordings from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection "Unlimited" Recording License cannot be exported. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: exportSoraCamDeviceRecordedVideo parameters: - description: Device ID of the target compatible camera device. @@ -11732,7 +12658,7 @@ paths: description: | Gets the list of the current status of the process of exporting recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedVideo API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one export process. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceExportedVideo parameters: - description: Device ID of the target compatible camera device. @@ -11813,7 +12739,7 @@ paths: - api_key: [] api_token: [] summary: Get the current status of the process of exporting recorded video taken - with a compatible camera device. + with a compatible camera device tags: - SoraCam x-soracom-cli: @@ -11898,7 +12824,7 @@ paths: type: array description: OK. "400": - description: The specified argument is invalid. + description: The specified value is invalid. security: - api_key: [] api_token: [] @@ -11917,7 +12843,7 @@ paths: description: | Gets the list of the current status of the process of exporting still image from recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage). This API can target all devices owned by the operator, or limit it to one compatible camera device. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceImageExports parameters: - description: Device ID of the target compatible camera device. If this ID @@ -12038,7 +12964,7 @@ paths: description: | Gets the list of the current status of the process of exporting recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedVideo API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedVideo). This API can target all devices owned by the operator, or limit it to one compatible camera device. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceVideoExports parameters: - description: Device ID of the target compatible camera device. If this ID @@ -12198,7 +13124,7 @@ paths: security: - api_key: [] api_token: [] - summary: List license packs of Soracom Cloud Camera Services. + summary: List license packs of Soracom Cloud Camera Services tags: - SoraCam x-soracom-cli: @@ -12206,11 +13132,11 @@ paths: /sora_cam/license_packs/{license_pack_id}/quantity: put: description: Updates the license quantity for the license pack identified by - license_pack_id. This operation will cost you monthly fee based on - number of licenses. Currently, this API is only available for Japan coverage. + license_pack_id. This operation will cost you monthly fee based on number + of licenses. Currently, this API is only available for Japan coverage. operationId: updateSoraCamLicensePackQuantity parameters: - - description: ID of the license pack + - description: ID of the license pack. in: path name: license_pack_id required: true @@ -12231,7 +13157,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update the license quantity of Soracom Cloud Camera Services. + summary: Update the license quantity of Soracom Cloud Camera Services tags: - SoraCam x-soracom-cli: @@ -12241,7 +13167,8 @@ paths: description: Returns a list of Soralets. operationId: listSoralets parameters: - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12251,7 +13178,7 @@ paths: - asc - desc type: string - - description: The maximum number of items in a response + - description: The maximum number of items in a response. in: query name: limit required: false @@ -12277,7 +13204,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Soralets. + summary: List Soralets tags: - Soralet x-soracom-cli: @@ -12306,7 +13233,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create a Soralet. + summary: Create a Soralet tags: - Soralet x-soracom-cli: @@ -12330,7 +13257,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Soralet. + summary: Delete Soralet tags: - Soralet x-soracom-cli: @@ -12357,7 +13284,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get a Soralet. + summary: Get a Soralet tags: - Soralet x-soracom-cli: @@ -12373,7 +13300,8 @@ paths: required: true schema: type: string - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12409,7 +13337,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get log messages from Soralet. + summary: Get log messages from Soralet tags: - Soralet x-soracom-cli: @@ -12435,7 +13363,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExecuteSoraletRequest' - description: request + description: Execution request. required: true responses: "200": @@ -12447,7 +13375,7 @@ paths: security: - api_key: [] api_token: [] - summary: Execute Soralet with arguments. + summary: Execute Soralet with arguments tags: - Soralet x-soracom-cli: @@ -12464,7 +13392,8 @@ paths: required: true schema: type: string - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12500,7 +13429,7 @@ paths: security: - api_key: [] api_token: [] - summary: List versions of Soralet. + summary: List versions of Soralet tags: - Soralet x-soracom-cli: @@ -12520,7 +13449,8 @@ paths: required: true schema: type: string - - description: Content type of the file to upload + - description: Content type of the file to upload. When uploading .wasm files, + please specify `application/json`. in: header name: content-type schema: @@ -12531,6 +13461,7 @@ paths: schema: format: binary type: string + description: Contents of the file you wish to upload. required: true responses: "201": @@ -12542,7 +13473,7 @@ paths: security: - api_key: [] api_token: [] - summary: Upload code and create a new version. + summary: Upload code and create a new version tags: - Soralet x-soracom-cli: @@ -12572,7 +13503,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete a Soralet version. + summary: Delete a Soralet version tags: - Soralet x-soracom-cli: @@ -12589,23 +13520,15 @@ paths: required: true schema: type: string - - description: "Start time for the aggregate data (UNIX time in seconds).\n\n- - If period is set to \"month\", valid values range from 3 months ago to the - current time. \n- If period is set to \"day\", valid values range from 6 - days ago to the current time. \n- The actual start time of the - period is 00:00:00 on the first day of the month or day containing the specified - UNIX time.\n" + - description: Specify the start month/day of the period to be aggregated in + UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: | - End time for the aggregate data (UNIX time in seconds). - - - If period is set to "month", valid values range from 3 months ago to the current time. - - If period is set to "day", valid values range from 6 days ago to the current time. - - The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time. + - description: Specify the end month/day of the period to be aggregated in UNIX + time in seconds. in: query name: to required: true @@ -12614,8 +13537,22 @@ paths: - description: | Unit of aggregation. - - month: Aggregate by month. - - day: Aggregate by day. + - `month`: Monthly. + + The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Daily + + The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | in: query name: period required: true @@ -12655,23 +13592,15 @@ paths: required: true schema: type: string - - description: "Start time for the aggregate data (UNIX time in seconds).\n\n- - If period is set to \"month\", valid values range from 3 months ago to the - current time. \n- If period is set to \"day\", valid values range from 6 - days ago to the current time. \n- The actual start time of the - period is 00:00:00 on the first day of the month or day containing the specified - UNIX time.\n" + - description: Specify the start month/day of the period to be aggregated in + UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: | - End time for the aggregate data (UNIX time in seconds). - - - If period is set to "month", valid values range from 3 months ago to the current time. - - If period is set to "day", valid values range from 6 days ago to the current time. - - The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time. + - description: Specify the end month/day of the period to be aggregated in UNIX + time in seconds. in: query name: to required: true @@ -12680,8 +13609,22 @@ paths: - description: | Unit of aggregation. - - month: Aggregate by month. - - day: Aggregate by day. + - `month`: Monthly. + + The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Daily + + The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | in: query name: period required: true @@ -12726,7 +13669,7 @@ paths: - description: | Specify how to obtain the URL to download the Air Data Usage Report CSV. - - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`. + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`. - `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. in: query name: export_mode @@ -12761,7 +13704,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Air Usage Report of All Subscribers. + summary: Export Air Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -12780,22 +13723,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the history of traffic at - the finest granularity. However, while the device is connected to the Soracom - platform, the communication volume is recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12836,22 +13804,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the history of traffic at - the finest granularity. However, while the device is connected to the Soracom - platform, the communication volume is recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12918,7 +13911,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Beam Usage Report of All Subscribers. + summary: Export Beam Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -12935,22 +13928,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12972,7 +13990,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Beam Usage Report of Subscriber. + summary: Get Beam Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13017,7 +14035,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Funk Usage Report of All Subscribers. + summary: Export Funk Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -13034,22 +14052,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13071,14 +14114,14 @@ paths: security: - api_key: [] api_token: [] - summary: Get Funk Usage Report of Subscriber. + summary: Get Funk Usage Report of Subscriber tags: - Stats x-soracom-cli: - stats funk get /stats/funnel/operators/{operator_id}/export: post: - description: Retrieves a file containing the SORACOM Funnel usage report of + description: Retrieves a file containing the Soracom Funnel usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV. @@ -13116,7 +14159,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Funnel Usage Report of All Subscribers. + summary: Export Funnel Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -13133,22 +14176,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13170,7 +14238,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Funnel Usage Report of Subscriber. + summary: Get Funnel Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13186,7 +14254,8 @@ paths: required: true schema: type: string - - description: Year/Month in 'YYYYMM' format. + - description: Specify the year and month from 18 months before the current + time to the current time in the YYYYMM format. in: query name: year_month required: false @@ -13207,6 +14276,55 @@ paths: - Stats x-soracom-cli: - stats harvest operators get + /stats/harvest/operators/{operator_id}/export: + post: + description: | + Download the Harvest Data Write Count Results Data CSV file that contains the usage report of all the IoT SIMs for the specified operator. + + **Info**: You can also check the Harvest Data write counts of the terminated IoT SIM. + operationId: exportHarvestStats + parameters: + - description: Operator ID. + in: path + name: operator_id + required: true + schema: + type: string + - description: | + Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV. + + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#!/Files/getExportedFile) to get the URL. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify `async`. + - `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. + in: query + name: export_mode + required: false + schema: + enum: + - async + - sync + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportRequest' + description: Export time period. + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FileExportResponse' + description: OK. + security: + - api_key: [] + api_token: [] + summary: Export Harvest Data Write Counts Report of all IoT SIMs + tags: + - Stats + x-soracom-cli: + - stats harvest export /stats/harvest/subscribers/{imsi}: get: description: Retrieves the Soracom Harvest usage report for the subscriber specified @@ -13219,22 +14337,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13256,7 +14399,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Harvest Usage Report of Subscriber. + summary: Get Harvest Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13266,7 +14409,8 @@ paths: description: Get Napter audit logs' monthly exported data stats. operationId: getNapterAuditLogsExportedDataStats parameters: - - description: Year/Month in 'YYYYMM' format. + - description: Specify the year and month from 18 months before the current + time to the current time in the YYYYMM format. in: query name: year_month required: false @@ -13324,9 +14468,19 @@ paths: required: false schema: type: string - - description: 'Speed class for filtering the search. Can specify multiple values - delimited by `|`. Valid values include: `s1.minimum`, `s1.slow`, `s1.standard`, - `s1.fast`' + - description: | + Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include: + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` in: query name: speed_class_filter required: false @@ -13519,11 +14673,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward. @@ -14745,7 +15902,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable: post: description: Disables SIM-Based Routing. - operationId: disableSimBasedRouging + operationId: disableSimBasedRouting parameters: - description: Target VPG ID. in: path @@ -14769,7 +15926,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable: post: description: Enables SIM-Based Routing. - operationId: enableSimBasedRouging + operationId: enableSimBasedRouting parameters: - description: Target VPG ID. in: path @@ -14821,7 +15978,7 @@ paths: security: - api_key: [] api_token: [] - summary: Associate a router's LAN IP address range with its SIM ID. + summary: Associate a router's LAN IP address range with its SIM ID tags: - VirtualPrivateGateway x-soracom-cli: @@ -15159,7 +16316,7 @@ paths: schema: default: "null" type: string - - description: Max number of results in a response + - description: Max number of results in a response. in: query name: limit required: false @@ -15184,7 +16341,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Packet Capture Sessions + summary: List Packet Capture Sessions associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: @@ -15195,7 +16352,7 @@ paths: response: header: x-soracom-next-key post: - description: Create a packet capture sessions associated the VPG. + description: Create a packet capture session associated with the VPG. operationId: createPacketCaptureSession parameters: - description: VPG ID @@ -15217,23 +16374,23 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Created a new packet capture sessions associated with the VPG + description: The packet capture sessions associated with the VPG "400": - description: Failed to create a packet capture sessions associated with - the VPG + description: Failed to create a packet capture session associated with the + VPG "404": description: The specified VPG does not exist. security: - api_key: [] api_token: [] - summary: Create Packet Capture Session + summary: Create a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg create-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}: delete: - description: Delete a packet capture sessions associated the VPG + description: Delete a packet capture session associated with the VPG. operationId: deletePacketCaptureSession parameters: - description: VPG ID @@ -15254,7 +16411,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Deleted the packet capture session associated with the VPG + description: Deleted the packet capture session "400": description: Failed to delete the packet capture session associated with the VPG @@ -15264,13 +16421,13 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Packet Capture Session + summary: Delete a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg delete-packet-capture-session get: - description: Get a packet capture sessions associated the VPG. + description: Get a packet capture session associated with the VPG. operationId: getPacketCaptureSession parameters: - description: VPG ID @@ -15298,14 +16455,14 @@ paths: security: - api_key: [] api_token: [] - summary: Get Packet Capture Session + summary: Get a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg get-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop: post: - description: Stop a packet capture session associated with the VPG + description: Stop a packet capture session associated with the VPG. operationId: stopPacketCaptureSession parameters: - description: VPG ID @@ -15334,11 +16491,12 @@ paths: description: The packet capture session associated with the VPG was not found "500": - description: The packet capture session could not be stopped. + description: The packet capture session associated with the VPG could not + be stopped. security: - api_key: [] api_token: [] - summary: Stop Packet Capture Session + summary: Stop a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: @@ -15471,7 +16629,10 @@ paths: - vpg delete-vpc-peering-connection /volume_discounts: get: - description: Returns a list of contracted long term discounts. + description: | + Returns a list of contracted long term discounts. + + **Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listVolumeDiscounts responses: "200": @@ -15483,22 +16644,22 @@ paths: security: - api_key: [] api_token: [] - summary: List long term discounts. + summary: List long term discounts tags: - Payment x-soracom-cli: - volume-discounts list post: description: Creates a new long term discount quotation. If the orderId is put - in /confirm, the order is complete. (Currently, long term discount is only - applied to plan-D, plan-K) + in /volume_discounts/{order_id}/confirm, the order is complete (Currently, + long term discount is only applied to plan-D, plan-K). operationId: createVolumeDiscountQuotation requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEstimatedVolumeDiscountRequest' - description: Long term discount contract details + description: Long term discount contract details. required: true responses: "201": @@ -15506,21 +16667,24 @@ paths: application/json: schema: $ref: '#/components/schemas/EstimatedVolumeDiscountModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create long term discount quotation. + summary: Create long term discount quotation tags: - Order x-soracom-cli: - volume-discounts create /volume_discounts/{contract_id}: get: - description: Returns contracted long term discount. + description: | + Returns contracted long term discount. + + **Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getVolumeDiscount parameters: - - description: contract_id + - description: Contract ID. in: path name: contract_id required: true @@ -15538,7 +16702,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get long term discount. + summary: Get long term discount tags: - Payment x-soracom-cli: @@ -15549,7 +16713,7 @@ paths: encountered. operationId: confirmVolumeDiscountOrder parameters: - - description: Order ID + - description: Order ID. in: path name: order_id required: true @@ -15565,7 +16729,7 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm long term discount order. + summary: Confirm long term discount order tags: - Order x-soracom-cli: @@ -15584,7 +16748,7 @@ paths: security: - api_key: [] api_token: [] - summary: List available long term discounts. + summary: List available long term discounts tags: - Order x-soracom-cli: @@ -15730,7 +16894,7 @@ components: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true DeviceObjectModel: content: @@ -15761,7 +16925,7 @@ components: application/json: schema: $ref: '#/components/schemas/LagoonPlanChangingRequest' - description: req + description: Request. required: true MFAAuthenticationRequest: content: @@ -15774,7 +16938,7 @@ components: APIAuditLogEntry: properties: apiKind: - description: The kind of the API. + description: The kind of the API (e.g., `/v1/auth`). type: string operatorId: description: The operator ID that called the API. @@ -15791,7 +16955,7 @@ components: format: int64 type: integer userName: - description: The SAM username that called the API, if this parameter is + description: The SAM username that called the API. If this parameter is empty, it means the caller user is the root user. type: string type: object @@ -15840,18 +17004,19 @@ components: ActionConfigProperty: properties: accessKey: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string body: - description: Only for ExecuteWebRequestAction (Optional) + description: Only for ExecuteWebRequestAction (Optional). type: string contentType: - description: Only for ExecuteWebRequestAction + description: Only for ExecuteWebRequestAction. type: string endpoint: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string executionDateTimeConst: + description: The timing of when the action should be performed. enum: - IMMEDIATELY - BEGINNING_OF_NEXT_MONTH @@ -15860,16 +17025,16 @@ components: - NEVER type: string executionOffsetMinutes: - description: Run in the minutes after the timing of executionDateTimeConst + description: Run in the minutes after the timing of executionDateTimeConst. type: string functionName: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string headers: - description: Only for ExecuteWebRequestAction (Optional) + description: Only for ExecuteWebRequestAction (Optional). type: object httpMethod: - description: Only for ExecuteWebRequestAction + description: Only for ExecuteWebRequestAction. enum: - GET - POST @@ -15877,43 +17042,46 @@ components: - DELETE type: string message: - description: Only for SendMailAction, SendMailToOperatorAction + description: Only for SendMailAction, SendMailToOperatorAction. type: string parameter1: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter2: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter3: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter4: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter5: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string secretAccessKey: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string speedClass: - description: Only for ChangeSpeedClassAction + description: Only for ChangeSpeedClassAction. enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string title: - description: Only for SendMailAction, SendMailToOperatorAction + description: Only for SendMailAction, SendMailToOperatorAction. type: string to: - description: Only for SendMailAction + description: Only for SendMailAction. type: string url: - description: Access URL and parameters. Only for ExecuteWebRequestAction + description: Access URL and parameters. Only for ExecuteWebRequestAction. type: string required: - executionDateTimeConst @@ -16082,32 +17250,32 @@ components: properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string taxIncludedUnitPrice: - description: Tax included unit price + description: Tax included unit price. format: double type: number unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -16117,7 +17285,7 @@ components: AvailableLongTermDiscountResponse: properties: availableLongTermDiscounts: - description: List of available long term discounts + description: List of available long term discounts. items: $ref: '#/components/schemas/AvailableLongTermDiscountModel' type: array @@ -16162,7 +17330,7 @@ components: - EUR type: string updatedTime: - description: Last updated time (unixtime in seconds). + description: Last updated time in UNIX time in seconds. format: int64 type: integer yearMonth: @@ -16185,7 +17353,7 @@ components: - EUR type: string updatedTime: - description: Last updated time (unixtime in seconds). + description: Last updated time in UNIX time in seconds. format: int64 type: integer yearMonth: @@ -16262,7 +17430,8 @@ components: ecid: type: string identifier: - description: optionally link the result to the request + description: An identifier to link a request to the result of that request. + Optional. type: string lac: type: string @@ -16295,17 +17464,18 @@ components: cell locations, and is included as-is in the response. type: string lat: - description: Latitude + description: Latitude. format: double type: number lon: - description: Longitude + description: Longitude. format: double type: number range: - description: Estimate of radio range, in meters. This is an estimate on - how large each cell area is, as a radius around the estimated position - and is based on the observations or a knowledgeable source. + description: Estimate of radio range (radius from the estimated coordinates. + In meters). This is an estimate on how large each cell area is, as a radius + around the estimated position and is based on the observations or a knowledgeable + source. format: int32 type: integer samples: @@ -16370,32 +17540,32 @@ components: CouponResponse: properties: amount: - description: Amount + description: Amount. format: double type: number balance: - description: Balance + description: Balance. format: double type: number billItemName: - description: Item + description: Item. type: string couponCode: - description: Coupon code + description: Coupon code. type: string currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string expiryYearMonth: - description: Expiry month + description: Expiry month. format: yyyyMM type: string orderId: - description: Order ID + description: Order ID. type: string type: object CoverageType: @@ -16420,7 +17590,7 @@ components: CreateEstimatedCouponRequest: properties: amount: - description: Amount + description: Amount. format: double type: number required: @@ -16429,19 +17599,19 @@ components: CreateEstimatedOrderRequest: properties: orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/OrderItemModel' type: array preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. format: yyyyMMdd type: string shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingOptions: - description: Shipping options + description: Shipping options. items: oneOf: - $ref: '#/components/schemas/ShippingOptionOfNekopos' @@ -16452,25 +17622,25 @@ components: properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -16514,6 +17684,8 @@ components: type: object CreateGroupRequest: properties: + configuration: + $ref: '#/components/schemas/GroupConfiguration' tags: $ref: '#/components/schemas/TagSet' type: object @@ -16522,7 +17694,7 @@ components: description: type: string permission: - description: Permission as JSON + description: Permission as JSON. type: string required: - permission @@ -16631,14 +17803,39 @@ components: type: integer type: enum: + - api-token-credentials - aws-credentials + - aws-iam-role-credentials - azure-credentials + - azureIoT-credentials + - esrij-credentials + - google-service-account-json + - googleIoT-credentials + - infoteria-platio-credentials + - kii-thingif-credentials + - landlog-credentials + - mmcloud-credentials + - mockmock-datarecorder-credentials + - motionboard-credentials + - optim-cloud-IoT-OS-credentials + - private-key-pem - psk + - pubnub-credentials + - sensorcorpus-credentials + - username-password-credentials + - watsonIoT-credentials - x509 type: string updateDateTime: format: int64 type: integer + required: + - createDateTime + - credentials + - credentialsId + - lastUsedDateTime + - type + - updateDateTime type: object CreditCard: properties: @@ -16786,11 +17983,14 @@ components: DiagnosticRequest: properties: from: - description: Start time for diagnostic (unixtime milliseconds) + description: Start time for diagnostic (UNIX time in milliseconds). format: int64 type: integer resourceId: - description: resourceId according to resourceType + description: | + Identifier according to resourceType. + + - If resourceType is `sim`, specify the SIM ID. type: string resourceType: enum: @@ -16801,7 +18001,7 @@ components: - Air type: string to: - description: End time for diagnostic (unixtime milliseconds) + description: End time for diagnostic (UNIX time in milliseconds). format: int64 type: integer required: @@ -16814,7 +18014,7 @@ components: diagnosticId: type: string from: - description: Start time for diagnostic (unixtime milliseconds) + description: Start time for diagnostic (UNIX time in milliseconds). format: int64 type: integer insights: @@ -16824,7 +18024,7 @@ components: type: object type: array resourceId: - description: resourceId according to resourceType + description: Identifier according to resourceType. type: string resourceType: enum: @@ -16841,7 +18041,7 @@ components: - failed type: string to: - description: End time for diagnostic (unixtime milliseconds) + description: End time for diagnostic (UNIX time in milliseconds). format: int64 type: integer type: object @@ -16873,15 +18073,21 @@ components: EmailConfigurationOfBilling: properties: attachInvoicePdfEnabled: - description: If true, an invoice PDF is attached with a monthly billing - notification mail (Global coverage only). + description: | + The setting to decide whether to attach the invoice PDF issued by Soracom to a monthly billing notification mail (Global coverage only). + + - `true`: The invoice will be attached. + - `false`: The invoice will not be attached. type: boolean type: object EmailConfigurationOfNotification: properties: exceedBundleDisabled: - description: If true, disable all notification emails that the traffic volume - is reaching a bundled volume. + description: | + The setting for notifications to the primary email address regarding data usage. For more information, refer to [Disabling Low Data Remaining Notifications](/en/docs/air/data-usage/#disabling-low-data-remaining-notifications). + + - `true`: All notifications to the primary email address regarding data usage will be disabled. + - `false`: All notifications to the primary email address regarding data usage will be enabled. type: boolean type: object EmailsModel: @@ -16904,6 +18110,8 @@ components: properties: totpUri: type: string + required: + - totpUri type: object Error: properties: @@ -16918,29 +18126,29 @@ components: EstimatedCouponModel: properties: amount: - description: Amount + description: Amount. format: double type: number currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string expiryYearMonth: - description: Expiry month + description: Expiry month. format: yyyyMM type: string orderId: - description: Order ID + description: Order ID. type: string taxAmount: - description: Tax amount + description: Tax amount. format: double type: number totalAmount: - description: Total amount + description: Total amount. format: double type: number type: object @@ -16949,11 +18157,11 @@ components: product: $ref: '#/components/schemas/ProductModel' productAmount: - description: Product amount + description: Product amount. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer taxIncludedProductAmount: @@ -16962,94 +18170,94 @@ components: EstimatedOrderModel: properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: oneOf: - $ref: '#/components/schemas/ShippingOptionOfNekopos' - $ref: '#/components/schemas/ShippingOptionOfExpeditedShipping' type: array balanceDue: - description: Balance due + description: Balance due. format: double type: number containsTaxIncludedAmounts: - description: Contains tax included amounts + description: Contains tax included amounts. type: boolean currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string email: - description: Email address + description: Email address. type: string orderChannel: - description: Order channel + description: Order channel. type: string orderId: - description: Order ID + description: Order ID. type: string orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. format: yyyyMMdd type: string purchaseOrderNumber: - description: Purchase order number + description: Purchase order number. type: string shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingCost: - description: Shipping cost + description: Shipping cost. format: double type: number taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxIncludedInShippingCost: - description: Tax included in shipping cost + description: Tax included in shipping cost. format: double type: number taxOnShippingCost: - description: Whether shipping cost is taxable + description: Whether shipping cost is taxable. type: boolean totalAmount: - description: Total amount + description: Total amount. format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object EstimatedVolumeDiscountModel: properties: currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string orderId: - description: Order ID + description: Order ID. type: string taxAmount: - description: Tax amount + description: Tax amount. format: double type: number totalAmount: - description: Total amount + description: Total amount. format: double type: number volumeDiscount: @@ -17165,24 +18373,47 @@ components: ExportRequest: properties: from: - description: Start date and time for the aggregate data (UNIX time in seconds) + description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. example: 1654009200 format: int64 type: integer period: description: | - Degree of detail of history. + Unit of aggregation. + + - `month`: Aggregate by month. - - `month`: Monthly - - `day`: Daily - - `minutes`: Every minute + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | enum: - month - day - minutes type: string to: - description: End date and time of the period covered (UNIX time in seconds) + description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. example: 1656601200 format: int64 type: integer @@ -17592,35 +18823,54 @@ components: attributes: properties: contractEndingTime: + description: Soracom LTE-M Button powered by AWS expiration date. format: date-time type: string firstClickTimestamp: + description: Date and time of first click on Soracom LTE-M Button powered + by AWS. format: date-time type: string remainingCount: + description: Soracom LTE-M Button powered by AWS remaining clicks. type: integer wimaxBillingStartDate: + description: Start date of billing for Soracom Cloud Camera Services + Cellular Pack. type: string wimaxIccid: + description: ICCID (Integrated Circuit Card ID) of the au IC card included + in the Soracom Cloud Camera Services Cellular Pack. Identifier to + identify the au IC card. type: string wimaxImei: + description: IMEI of the router included in the Soracom Cloud Camera + Services Cellular Pack. type: string type: object createdTime: + description: UNIX time (in milliseconds) that the Gadget API compatible + device was registered. format: int64 type: integer id: + description: ID of the Gadget API compatible device. type: string lastModifiedTime: + description: UNIX time (in milliseconds) that the Gadget API compatible + device information was changed. format: int64 type: integer lastSeen: properties: batteryLevel: + description: Battery level of Soracom LTE-M Button powered by AWS. type: integer clickEventPropagated: type: boolean clickTime: + description: Date and time of click on Soracom LTE-M Button powered + by AWS. format: date-time type: string clickType: @@ -17630,15 +18880,28 @@ components: type: string type: object operatorId: + description: Operator ID with which the Gadget API compatible device is + registered. type: string productId: + description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. enum: - button - wimax type: string serialNumber: + description: Serial Number of the target Gadget API compatible device. type: string status: + description: | + Contract status of the Gadget API compatible device. + + - `active`: In use. + - `terminated`: Cancelled. enum: - active - terminated @@ -17646,12 +18909,20 @@ components: tags: additionalProperties: type: string + description: Tags. type: object terminatedTime: + description: The cancellation date and time of the Gadget API compatible + device. If not cancelled, `null`. format: int64 type: integer terminationEnabled: default: false + description: | + Termination protection for Gadget API compatible device. + + - `true`: OFF (can be cancelled) + - `false`: ON (cannot cancel) type: boolean type: object GadgetRegistrationRequest: @@ -17659,6 +18930,7 @@ components: tags: additionalProperties: type: string + description: Tags. type: object type: object GatePeer: @@ -17685,8 +18957,8 @@ components: default: 86400 description: | New API token expiry duration in seconds. - Default: 86400 [seconds] (24 hours) - Maximum: 172800 [seconds] (48 hours) + Default: 86400 [seconds] (24 hours). + Maximum: 172800 [seconds] (48 hours). maximum: 172800 type: integer type: object @@ -17773,43 +19045,43 @@ components: GetOrderResponse: properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: type: object type: array balanceDue: - description: Balance due + description: Balance due. format: double type: number containsTaxIncludedAmounts: type: boolean currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string email: - description: Email address + description: Email address. type: string orderChannel: - description: Order channel + description: Order channel. type: string orderDateTime: - description: Order date and time (yyyyMMddHHmmss) + description: Order date and time (yyyyMMddHHmmss). format: yyyyMMddHHmmss type: string orderId: - description: Order ID + description: Order ID. type: string orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array orderStatus: - description: Order status + description: Order status. enum: - ordering - ordered @@ -17820,48 +19092,93 @@ components: - cancelled - failed type: string + paymentStatus: + description: | + Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/en-us/articles/360029337031). + + - `lessThanMinimumCharge`: Will be billed in the next month or later. (due to less than minimum charge.) + - `paying`: Payment in progress. + - `paid`: Paid. + - `fail`: Process failed. + - `refunding`: Refund in progress. + - `refunded`: Refunded. + - `refund_fail`: Refund failed. + - `delegating_to_third_party`: Delegating receivables. + - `delegated_to_third_party`: Delegated. + - `charging`: Charging in progress. + - `canceling`: Canceling. + - `cancelled`: Cancelled. + - `cancel_failed`: Failed to cancel. + enum: + - lessThanMinimumCharge + - paying + - paid + - fail + - refunding + - refunded + - refund_fail + - delegating_to_third_party + - delegated_to_third_party + - charging + - canceling + - cancelled + - cancel_failed + type: string preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. type: string purchaseOrderNumber: - description: Purchase order number + description: Purchase order number. type: string resourceInitialSetting: $ref: '#/components/schemas/ResourceInitialSetting' shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingCost: - description: Shipping cost + description: Shipping cost. format: double type: number + shippingDateTime: + description: Shipping date and time (yyyyMMddHHmmss). + example: 20231004123456 + format: yyyyMMddHHmmss + type: string + shippingLabelDetails: + description: Shipping label details. + items: + $ref: '#/components/schemas/ShippingLabelDetail' + type: array shippingLabelNumber: - description: Shipping label number (representative) + description: Shipping label number (representative). + example: 0000-1111-2222 type: string shippingLabelNumbers: - description: Shipping label numbers + description: Shipping label numbers. + example: + - 0000-1111-2222 items: type: string type: array taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxIncludedInShippingCost: - description: Tax included in shipping cost + description: Tax included in shipping cost. format: double type: number taxOnShippingCost: - description: Whether shipping cost is taxable + description: Whether shipping cost is taxable, type: boolean totalAmount: - description: Total amount + description: Total amount. format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object @@ -17958,10 +19275,10 @@ components: phoneNumber: type: string shippingAddressId: - description: ID of shipping address + description: ID of shipping address. type: string shippingArea: - description: shipping area + description: Shipping area. type: string state: type: string @@ -17997,63 +19314,65 @@ components: - SRN (Soracom Resource Name) representing the user of another account who is allowed to switch to this SAM user. - Conditions where switching is allowed. + + For details, please refer to [trust policy syntax](https://users.soracom.io/ja-jp/docs/switch-user/trust-policy/) (Japanese). type: string type: object GetVolumeDiscountResponse: properties: contractDateTime: - description: Contract date time + description: Contract date time. example: yyyyMMddHHmmss type: string contractId: - description: Contract ID + description: Contract ID. type: string contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string endDate: - description: End date + description: End date. example: yyyyMMdd type: string initialCost: - description: Initial cost + description: Initial cost. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string status: - description: Status + description: Status. enum: - active - expired type: string unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -18063,7 +19382,7 @@ components: Group: properties: configuration: - $ref: '#/components/schemas/Map' + $ref: '#/components/schemas/GroupConfiguration' createdTime: format: int64 type: integer @@ -18077,6 +19396,27 @@ components: tags: $ref: '#/components/schemas/TagSet' type: object + GroupConfiguration: + additionalProperties: + description: | + Keys are one of the following namespaces: + + - SoracomAir + - SoracomBeam + - SoracomEndorse + - SoracomOrbit + - SoracomFunk + - SoracomFunnel + - SoracomHarvest + - SoracomHarvestFiles + - SoracomKrypton + - UnifiedEndpoint + + The values are objects corresponding to their respective namespace. + type: object + description: | + Group configuration. + type: object GroupConfigurationUpdateRequest: properties: key: @@ -18143,8 +19483,8 @@ components: properties: anomalyDetectedTimes: description: Times that possible anomaly behaviors were detected. The format - depends on the timestamp of events relating to the category. (e.g. unixtime - milliseconds for session category) + depends on the timestamp of events relating to the category. (e.g., UNIX + time in milliseconds for session category) items: type: string type: array @@ -18161,7 +19501,7 @@ components: message: type: string referenceUrls: - description: Reference URLs that is related to the insight + description: Reference URLs that is related to the insight. items: additionalProperties: $ref: '#/components/schemas/ReferenceUrl' @@ -18193,10 +19533,10 @@ components: IssueAddEmailTokenRequest: properties: email: - description: Email address to be added + description: Email address to be added. type: string password: - description: Password of the operator + description: Password of the root user. type: string required: - email @@ -18335,8 +19675,8 @@ components: licensePackName: description: | Specify the license packs for which you want to update the number. - - `basicUser`: User License Pack - - `basicDashboard`: Dashboard License Pack + - `basicUser`: User License Pack. + - `basicDashboard`: Dashboard License Pack. enum: - basicUser - basicDashboard @@ -18347,7 +19687,7 @@ components: LagoonMigrationRequest: properties: dashboardIds: - description: A list of dashboard IDs to migrate + description: A list of dashboard IDs to migrate. items: type: string type: array @@ -18462,7 +19802,7 @@ components: ListOrderResponse: properties: orderList: - description: List of confirmed orders + description: List of confirmed orders. items: $ref: '#/components/schemas/GetOrderResponse' type: array @@ -18470,7 +19810,7 @@ components: ListOrderedSubscriberResponse: properties: orderedSubscriberList: - description: List of ordered SIMs + description: List of ordered SIMs. items: $ref: '#/components/schemas/OrderedSubscriber' type: array @@ -18478,7 +19818,7 @@ components: ListPaymentStatementResponse: properties: paymentStatementsList: - description: Payment statements + description: Payment statements. items: $ref: '#/components/schemas/PaymentStatementResponse' type: array @@ -18517,7 +19857,7 @@ components: ListVolumeDiscountResponse: properties: volumeDiscountList: - description: Contracted long term discounts + description: Contracted long term discounts. items: $ref: '#/components/schemas/GetVolumeDiscountResponse' type: array @@ -18682,7 +20022,7 @@ components: MFARevokeRequest: properties: password: - description: Root user's password + description: Root user's password. type: string required: - password @@ -18714,6 +20054,7 @@ components: format: double type: number appliedCouponAmount: + description: Amount of coupon applied. format: double type: number currency: @@ -18725,7 +20066,7 @@ components: type: string paymentStatus: description: | - Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/ja/articles/360029337031) (Japanese). + Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/en-us/articles/360029337031). - `lessThanMinimumCharge`: Will be billed in the next month or later. (due to less than minimum charge) - `paying`: Payment in progress @@ -18852,6 +20193,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfEmail' - $ref: '#/components/schemas/OperatorConfigurationOfSupport' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' isModifiable: description: If false, the operator configuration cannot be updated by setOperatorConfigurationNamespace API. @@ -18890,6 +20232,19 @@ components: description: Support tier that will be applied for the next month. If the value is null, the current tier will continue for the next month. type: object + OperatorConfigurationOfUserConsole: + properties: + usageMetricsAcknowledged: + description: This setting is to check if an operator has acknowledged and + had the chance to opt-out of usage metrics collection. Usage metrics includes + information such as page views and performance statistics. + type: boolean + usageMetricsDisabled: + description: The setting whether to disable usage metrics collection for + an operator of the User Console. Usage metrics includes information such + as page views and performance statistics. + type: boolean + type: object OperatorMFAVerifyingResponse: properties: backupCodes: @@ -18900,40 +20255,40 @@ components: OrderItemModel: properties: productCode: - description: Product code + description: Product code. type: string quantity: - description: Quantity + description: Quantity. format: int32 type: integer type: object OrderedSubscriber: properties: bundles: - description: Bundles + description: Bundle. items: type: string type: array deviceSerialNumber: - description: Serial number of Device + description: Serial number of Device. type: string eiccid: - description: eICCID + description: eICCID. type: string iccid: - description: ICCID + description: ICCID. type: string imsi: - description: IMSI + description: IMSI. type: string msisdn: - description: MSISDN + description: MSISDN. type: string serialNumber: - description: Serial number of IoT SIM + description: Serial number of IoT SIM. type: string simId: - description: SIM ID + description: SIM ID. type: string type: object PacketCaptureSession: @@ -18984,10 +20339,10 @@ components: - duration type: object PaymentAmount: - description: Payment amount + description: Payment amount. properties: currency: - description: Currency + description: Currency. enum: - JPY - USD @@ -18998,30 +20353,30 @@ components: subTotalAmount: type: number taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxFreeSubTotalAmount: - description: Tax free sub total amount + description: Tax free sub total amount. format: double type: number taxRate: type: object taxableSubTotalAmount: - description: Taxable sub total amount + description: Taxable sub total amount. format: double type: number totalAmount: - description: Total amount (tax included) + description: Total amount (tax included). format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object PaymentDescription: - description: Payment description + description: Payment description. properties: description: type: string @@ -19033,7 +20388,7 @@ components: PaymentStatementResponse: properties: amount: - description: Amount + description: Amount. format: double type: number chargedYearMonths: @@ -19045,28 +20400,27 @@ components: type: string type: array currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string orderId: - description: Order ID. If the payment is not for an order, this field is - omitted. + description: Order ID. If the billing is not an order, this field is omitted. type: string paymentDateTime: - description: Payment date time + description: Payment date time. format: int64 type: integer paymentInstrument: - description: Payment instrument + description: Payment instrument. type: string paymentMethod: - description: Payment method + description: Payment method. type: string paymentStatementId: - description: Payment statement ID + description: Payment statement ID. type: string paymentStatementInfo: description: Payment statement information @@ -19079,14 +20433,13 @@ components: - aws type: string region: - default: eu-central-1 description: | If `infrastructureProvider` is `aws`, it indicates the rendezvous point. - - `ap-northeast-1`: Tokyo (Japan) - - `eu-central-1`: Frankfurt (Germany) - - `us-west-2`: Oregon (USA) - - `ap-southeast-2`: Sydney (Australia) + - `ap-northeast-1`: Tokyo (Japan). The default for Japan coverage. + - `eu-central-1`: Frankfurt (Germany). The default for Global coverage. + - `us-west-2`: Oregon (USA). + - `ap-southeast-2`: Sydney (Australia). enum: - ap-northeast-1 - eu-central-1 @@ -19123,11 +20476,29 @@ components: PortMappingDestination: properties: imsi: - description: The target IMSI of the subscriber. + description: The target IMSI of the subscriber. If `simId` parameter is + specified, this parameter will be ignored. type: string port: description: The port on your device used for access. type: number + service: + description: | + A switch parameter to decide the target for creating a port mapping. This parameter is enabled when the `simId` parameter is specified. + + - `air`: The destination will be a SORACOM Air subscriber which has an online session. + - `arc`: The destination will be a SORACOM Arc subscriber. + + **Warning**: In the default case, i.e. this parameter is missing, an online subscription in a SIM will be a target of the port-mapping creation. If there are multiple online sessions, in other words a SIM has SORACOM Air's online session and SORACOM Arc's online session, it doesn't guarantee which one will be a target for the port mapping creation. We recommend specifying `air` or `arc`. + enum: + - air + - arc + type: string + simId: + description: The target SIM ID of the SIM. It prioritizes this parameter + over `imsi` parameter. If this parameter has been given, it attempts to + create a port mapping according to the `service` parameter. + type: string required: - imsi - port @@ -19178,67 +20549,68 @@ components: PriceByQuantity: properties: minQuantity: - description: Min quantity + description: Min quantity. format: int32 type: integer price: - description: Price + description: Price, format: double type: number taxIncludedPrice: - description: TaxIncluded price + description: Tax Included price. format: double type: number type: object ProductModel: - description: Product + description: Product. properties: campaignCode: - description: Campaign code + description: Campaign code. type: string consignorId: - description: Consignor ID + description: Consignor ID. type: string consignorName: - description: Consignor name + description: Consignor name. type: string count: - description: Count + description: Count. format: double type: number currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string description: - description: Product Description + description: Product Description. type: string maxQuantity: - description: Max quantity + description: Max quantity. format: int32 type: integer price: - description: Price + description: Price, format: double type: number priceByQuantityList: + description: Price List by Quantity. items: $ref: '#/components/schemas/PriceByQuantity' type: array productCode: - description: Product code + description: Product code. type: string productInfoURL: - description: URL of product page + description: URL of product page. type: string productName: - description: Product name + description: Product name. type: string productType: - description: Product type + description: Product type. enum: - sim - lora @@ -19249,18 +20621,18 @@ components: properties: additionalProperties: type: string - description: Properties + description: Properties. type: object regularPrice: - description: Regular price + description: Regular price. format: double type: number taxIncludedPrice: - description: Price + description: Tax Included price. format: double type: number taxIncludedRegularPrice: - description: TaxIncluded regular price + description: Tax included regular price. format: double type: number type: object @@ -19309,29 +20681,16 @@ components: type: string type: object type: object - RegisterOperatorsRequest: - properties: - email: - type: string - password: - description: 'Requirements for password: At least 8 characters (max 100), - a mixture of lowercase (a-z), uppercase (A-Z), number (0-9) letters. You - can use symbols.' - type: string - required: - - email - - password - type: object RegisterPayerInformationModel: properties: companyName: description: Company name type: string department: - description: Department + description: Department. type: string fullName: - description: Full name + description: Full name. type: string type: object RegisterSimRequest: @@ -19351,7 +20710,7 @@ components: groupId: type: string registrationSecret: - description: PUK or PASSCODE for IoT SIM + description: PUK or PASSCODE for IoT SIM. type: string tags: $ref: '#/components/schemas/TagSet' @@ -19364,8 +20723,20 @@ components: simInitialSettings: additionalProperties: $ref: '#/components/schemas/SimInitialSetting' - description: Initial setting of SIMs for each subscription. The key specifies - a subscription. + description: | + Initial setting of SIMs for each subscription. The key specifies a subscription. + + - `plan01s` + - `plan01s-low_data_volume` (plan01s - Low Data Volume) + - `planX3` (planX3 X3-5MB) + - `planP1` + - `plan-D` (plan-D, plan-D D-300MB) + - `plan-K2` (plan-K2 K2-300MB) + - `plan-DU` + - `plan-KM1` + - `plan-K` + - `plan-US` + - `plan-NA1-package` (plan-NA1) example: plan01s: groupId: 00000000-1111-2222-3333-444444444444 @@ -19434,7 +20805,7 @@ components: description: | The type of the resource summary. - - `simsPerStatus`: The number of IoT SIMs per status + - `simsPerStatus`: The number of IoT SIMs per status. example: simsPerStatus type: string type: object @@ -19447,8 +20818,8 @@ components: $ref: '#/components/schemas/ResourceSummaryItemDimension' type: array updatedTime: - description: The last updated time of the resource summary item (unixtime - milliseconds). + description: The last updated time of the resource summary item (UNIX time + in milliseconds). example: 1654007722000 format: int64 type: integer @@ -19474,11 +20845,11 @@ components: The name of the resource summary item value. - if `resourceSummaryType` is `simsPerStatus`: - - `readySims`: The number of IoT SIMs of which status is ready - - `activeSims`: The number of IoT SIMs of which status is active - - `inactiveSims`: The number of IoT SIMs of which status is inactive - - `standbySims`: The number of IoT SIMs of which status is standby - - `suspendedSims`: The number of IoT SIMs of which status is suspended + - `readySims`: The number of IoT SIMs of which status is ready. + - `activeSims`: The number of IoT SIMs of which status is active. + - `inactiveSims`: The number of IoT SIMs of which status is inactive. + - `standbySims`: The number of IoT SIMs of which status is standby. + - `suspendedSims`: The number of IoT SIMs of which status is suspended. example: activeSims type: string value: @@ -19494,7 +20865,7 @@ components: description: type: string permission: - description: Permission as JSON + description: Permission as JSON. type: string roleId: type: string @@ -19570,23 +20941,26 @@ components: - false type: string targetOtaStatus: - description: Only for SimSubscriptionStatusRule + description: Only for SimSubscriptionStatusRule. enum: - started - finished - failed type: string targetSpeedClass: - description: Only for SubscriberSpeedClassAttributeRule, SimSpeedClassAttributeRule + description: Only for SubscriberSpeedClassAttributeRule, SimSpeedClassAttributeRule. enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string targetStatus: - description: Only for SubscriberStatusAttributeRule, SimStatusAttributeRule + description: Only for SubscriberStatusAttributeRule, SimStatusAttributeRule. enum: - ready - active @@ -19708,6 +21082,10 @@ components: SetImeiLockRequest: properties: imei: + description: | + IMEI of the target device. If you want to establish a session even when the IMEI is temporarily not reported, append `|ANONYMOUS` to the IMEI value. + + For example, if the IMEI specified is `123456789012345`, specifying `123456789012345|ANONYMOUS` as the parameter value will allow a session to be established even when the IMEI is temporarily not reported. type: string type: object SetNetworkSetRequest: @@ -19721,11 +21099,12 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfSupport' - $ref: '#/components/schemas/OperatorConfigurationOfEmail' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' expectedVersion: - description: This property is used to avoid update confliction. To use - it, retrieve the version by getOperatorConfigurationNamespace API, then - specify the version here. If the expectedVersion is not specified, the - API does not check an update confliction. + description: This property is used to avoid update confliction. To use it, + retrieve the version by getOperatorConfigurationNamespace API, then specify + the version here. If the expectedVersion is not specified, the API does + not check an update confliction. type: number required: - configuration @@ -19760,7 +21139,7 @@ components: type: string type: object ShippingAddressModel: - description: Shipping address + description: Shipping address. properties: addressLine1: type: string @@ -19793,22 +21172,22 @@ components: - zipCode type: object ShippingCostModel: - description: Shipping cost + description: Shipping cost. properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: type: object type: array currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string shippingArea: - description: (Japan coverage only) Shipping area + description: (Japan coverage only) Shipping area. enum: - hokkaido - kita_tohoku @@ -19824,17 +21203,39 @@ components: - okinawa type: string shippingAreaName: - description: Shipping Area name + description: Shipping Area name. type: string shippingCost: - description: Shipping Cost + description: Shipping Cost. format: double type: number size: - description: Size + description: Size. format: int32 type: integer type: object + ShippingLabelDetail: + properties: + shipmentCompany: + description: Shipment company name. + example: Yamato Transport + type: string + shipmentCompanyUrl: + description: Shipment company URL. + example: http://track.kuronekoyamato.co.jp/english/tracking + type: string + trackingNumber: + description: Tracking number. + example: 0000-1111-2222 + type: string + trackingUrl: + description: Tracking URL with tracking number. + example: https://jizen.kuronekoyamato.co.jp/jizen/servlet/crjz.b.NQ0010?id=0000-1111-2222 + type: string + required: + - shipmentCompany + - trackingNumber + type: object ShippingOptionOfExpeditedShipping: description: Available for United States and Canada operators only. properties: @@ -19850,7 +21251,7 @@ components: description: Specify true to allow use of Nekopos. type: boolean shipmentCompany: - description: Shipment company + description: Shipment company. enum: - yamato_transport type: string @@ -20057,7 +21458,29 @@ components: description: Group ID. type: string speedClass: - description: Speed class. + description: | + Speed class. Specify one of the following. Please specify the speed class that matches the subscription. + + - For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - For plan-US: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - For plan-DU: + - `u1.standard` + - `u1.slow` + - For plan-KM1: + - `t1.standard` + - For virtual SIM/Subscriber: + - `arc.standard` type: string tags: additionalProperties: @@ -20086,6 +21509,31 @@ components: $ref: '#/components/schemas/SimplifiedSubscriber' type: object type: object + SimStatusHistoryResponse: + properties: + applyDateTimeEpochSec: + type: integer + bundles: + items: + type: string + type: array + groupId: + type: string + imsi: + type: string + isPrimary: + type: boolean + primaryImsi: + type: string + simId: + type: string + speedClass: + type: string + status: + type: string + subscription: + type: string + type: object SimplifiedSubscriber: properties: bundles: @@ -20126,6 +21574,178 @@ components: payload: type: string type: object + SoraCamAtomCamSettings: + properties: + logo: + description: | + Display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + motionTagging: + description: | + Display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + nightVision: + description: | + Settings for night vision mode. + + - `on`: Night vision mode. + - `off`: Normal mode. + - `auto`: Auto-switching. + enum: + - "on" + - "off" + - auto + type: string + quality: + description: | + Settings for the live video and cloud recording quality. Note that for cloud recordings, the resolution is 1080p (1920 x 1080 pixels), regardless of the quality setting. + + - `low`: The same quality as selecting "360p" in the ATOM app. + - `medium`: The same quality as selecting "SD" in the ATOM app. + - `high`: The same quality as selecting "HD (1080p)" in the ATOM app. + enum: + - low + - medium + - high + type: string + rotation: + description: | + Settings for rotating the image by 180 degrees. Set to `180` when installing the compatible camera device upside down. + + - `0`: OFF (no rotation). + - `180`: ON (180-degree rotation). + enum: + - 0 + - 180 + type: integer + statusLight: + description: | + Settings for the status light (indicator light that shows the status of the camera). + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + timestamp: + description: | + Display settings for the timestamp shown on the bottom right of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsLogo: + properties: + state: + description: | + Display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsMotionTagging: + properties: + state: + description: | + Display settings for motion tagging. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsNightVision: + properties: + state: + description: | + Settings for night vision mode. + + - `on`: Night vision mode. + - `off`: Normal mode. + - `auto`: Auto-switching. + enum: + - "on" + - "off" + - auto + type: string + type: object + SoraCamAtomCamSettingsQuality: + properties: + state: + description: | + Settings for the live video and cloud recording quality. Note that for cloud recordings, the resolution is 1080p (1920 x 1080 pixels), regardless of the quality setting. + + - `low`: The same quality as selecting "360p" in the ATOM app. + - `medium`: The same quality as selecting "SD" in the ATOM app. + - `high`: The same quality as selecting "HD (1080p)" in the ATOM app. + enum: + - low + - medium + - high + type: string + type: object + SoraCamAtomCamSettingsRotation: + properties: + state: + description: | + Settings for rotating the image by 180 degrees. Set to `180` when installing the compatible camera device upside down. + + - `0`: OFF (no rotation). + - `180`: ON (180-degree rotation). + enum: + - 0 + - 180 + type: integer + type: object + SoraCamAtomCamSettingsStatusLight: + properties: + state: + description: | + Settings for the status light (indicator light that shows the status of the camera). + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsTimestamp: + properties: + state: + description: | + Display settings for the timestamp shown on the bottom right of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object SoraCamDevice: properties: appliedLicenses: @@ -20190,11 +21810,17 @@ components: description: | Properties of the license applied to a compatible camera device. - If `name` is `Cloud Continuous Recording License (x Days)` or `Cloud Motion Detection "Unlimited" Recording License (x Days)`: + If `name` is `Cloud Continuous Recording License (x Days)` or + `Cloud Motion Detection "Unlimited" Recording License (x Days)`: - `storage_life`: Storage life. type: string type: object + SoraCamDeviceName: + properties: + name: + type: string + type: object SoraCamEvent: properties: deviceId: @@ -20384,12 +22010,12 @@ components: SoraCamLicensePackQuantityUpdatingRequest: properties: currentQuantity: - description: Current license quantity of the license pack + description: Current license quantity of the license pack. example: 1 format: int32 type: integer desiredQuantity: - description: Desired license quantity of the license pack + description: Desired license quantity of the license pack. example: 2 format: int32 type: integer @@ -20397,20 +22023,20 @@ components: SoraCamLicensePackResponse: properties: id: - description: ID of the license pack + description: ID of the license pack. example: CR7-SC type: string name: - description: Name of the license pack + description: Name of the license pack. example: Cloud Recording License (7 Days) type: string quantity: - description: Current license quantity of the license pack + description: Current license quantity of the license pack. example: 1 format: int32 type: integer salesChannel: - description: Sales channel of the license pack + description: Sales channel of the license pack. example: SORACOM Inc. type: string type: object @@ -20436,6 +22062,62 @@ components: - When trying to get recorded video, there is no recorded video between the specified `from` and `to`. type: string type: object + SoraCamPowerState: + properties: + powerState: + description: | + Power state of the compatible camera device. + + - `on` + - `sleep` + enum: + - "on" + - sleep + type: string + type: object + SoraCamRecordingsAndEventsList: + properties: + events: + items: + properties: + endTime: + description: Timestamp when the event is ended (unix time in milliseconds). + format: int64 + type: integer + startTime: + description: Timestamp when the event is started (unix time in milliseconds). + format: int64 + type: integer + type: + description: | + Type of the event. + + - `motion`: Motion Alert. + - `sound`: Sound Alert. + - `other`: Others. + enum: + - motion + - sound + - other + type: string + type: object + type: array + records: + items: + properties: + endTime: + description: Timestamp when the recording is ended (unix time in milliseconds). + `endTime` is not included for ongoing recordings. + format: int64 + type: integer + startTime: + description: Timestamp when the recording is started (unix time in + milliseconds). + format: int64 + type: integer + type: object + type: array + type: object SoraCamStreamingVideo: properties: expiryTime: @@ -20862,7 +22544,7 @@ components: type: string type: array type: - description: Notification type + description: Email address type. enum: - primary - recovery @@ -20934,17 +22616,25 @@ components: speedClass: description: | Speed class. Specify one of the following. Please specify the speed class that matches the subscription. - - For plan01s, plan01s - Low Data Volume, planP1, planX3 X3-5MB, plan-D: + + - For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: - `s1.minimum` - `s1.slow` - `s1.standard` - `s1.fast` - `s1.4xfast` - - For plan-KM1: - - `t1.standard` + - For plan-US: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` - For plan-DU: - `u1.standard` - `u1.slow` + - For plan-KM1: + - `t1.standard` - For virtual SIM/Subscriber: - `arc.standard` enum: @@ -20953,9 +22643,10 @@ components: - s1.standard - s1.fast - s1.4xfast - - t1.standard + - s1.8xfast - u1.standard - u1.slow + - t1.standard - arc.standard type: string required: @@ -20994,14 +22685,7 @@ components: VerifyAddEmailTokenRequest: properties: token: - description: Token sent by email - type: string - required: - - token - type: object - VerifyOperatorsRequest: - properties: - token: + description: Token sent by email. type: string required: - token @@ -21132,56 +22816,56 @@ components: type: string type: object VolumeDiscountModel: - description: Long term discount + description: Long term discount. properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string endDate: - description: End date + description: End date. example: yyyyMMdd type: string initialCost: - description: Initial cost + description: Initial cost. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string taxIncludedInitialCost: - description: Tax included initial cost + description: Tax included initial cost. format: double type: number taxIncludedUnitPrice: - description: Tax included unit price + description: Tax included unit price. format: double type: number unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE diff --git a/generators/assets/soracom-api.ja.yaml b/generators/assets/soracom-api.ja.yaml index 75f50a7d..16644fd5 100644 --- a/generators/assets/soracom-api.ja.yaml +++ b/generators/assets/soracom-api.ja.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM API v1 title: SORACOM API - version: 20230704-081118 + version: 20231114-073703 servers: - description: Japan coverage production API url: https://api.soracom.io/v1 @@ -313,7 +313,7 @@ paths: description: | 過去の確定した利用料金を月ごとに一括で取得します。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBillingHistory responses: "200": @@ -347,7 +347,7 @@ paths: description: | 指定した月の確定した利用料金を取得します。今月 (利用料金が未確定の月) を指定した場合は、速報値を取得します。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBilling parameters: - description: 対象年月 @@ -387,7 +387,7 @@ paths: description: | 指定した月の、日ごとの利用料金を取得します。また、月額で課金される利用料金は取得できません。今月 (利用料金が未確定の月) を指定した場合は、速報値が返されます。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBillingPerDay parameters: - description: 対象年月 @@ -426,7 +426,7 @@ paths: description: | 過去の [課金詳細情報 CSV](/ja-jp/guides/accounting/check-usage/billing-csv/) を専用ストレージにエクスポートして、ダウンロードするための URL を発行します。 - **Warning**: ダウンロードできる課金詳細情報 CSV は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: exportBilling parameters: - description: 対象年月 @@ -546,38 +546,6 @@ paths: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - - amount: 0.09 - billItemCategory: Beam - billItemName: soracomBeamRequestCharge-inHttp - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - amount: 1.8 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfBillItems' @@ -602,33 +570,6 @@ paths: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - simId: "1234567890123456780" - - amount: 0.12 - simId: "1234567890123456781" - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - - amount: 1.8 - simId: "1234567890123456780" - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfSims' @@ -645,7 +586,7 @@ paths: /cell_locations: get: description: | - セル ID などの基地局情報から、その基地局の位置情報（緯度経度）を取得します。 + セル ID などの基地局情報から、その基地局の位置情報 (緯度経度) を取得します。 3G の場合は MCC, MNC, LAC, CID を指定してください。CID がなくてもおおよその位置を取得することができますが、精度は高くありません。 LTE (4G) の場合は MCC, MNC, TAC, ECID を指定してください。 基地局情報から位置情報への変換には外部のオープンなデータベースを利用していますので、情報が存在していなかったり誤っている場合もあります。 @@ -665,49 +606,49 @@ paths: ``` operationId: getCellLocation parameters: - - description: MCC (Mobile Country Code) - 国コード + - description: MCC (Mobile Country Code) - 国コード。 example: 440 in: query name: mcc required: true schema: type: string - - description: MNC (Mobile Network Code) - ネットワークコード + - description: MNC (Mobile Network Code) - ネットワークコード。 example: 10 in: query name: mnc required: true schema: type: string - - description: LAC (Location Area Code) - エリアコード（3G 用） + - description: LAC (Location Area Code) - エリアコード (3G 用)。 example: 195 in: query name: lac required: false schema: type: string - - description: CID (Cell ID) - セル ID（3G 用） + - description: CID (Cell ID) - セル ID (3G 用)。 example: 68485165 in: query name: cid required: false schema: type: string - - description: TAC (Tracking Area Code) - エリアコード（LTE 用） + - description: TAC (Tracking Area Code) - エリアコード (LTE 用)。 example: 5840 in: query name: tac required: false schema: type: string - - description: ECID (Enhanced Cell ID) - セル ID（LTE 用） - `ecid` もしくは `eci` のいずれかを指定してください。（どちらに値を指定しても結果は同一です） + - description: ECID (Enhanced Cell ID) - セル ID (LTE 用) - `ecid` もしくは `eci` のいずれかを指定してください。どちらに値を指定しても結果は同一です。 example: 44668480 in: query name: ecid required: false schema: type: string - - description: ECID (Enhanced Cell ID) - セル ID（LTE 用） - `ecid` もしくは `eci` のいずれかを指定してください。（どちらに値を指定しても結果は同一です） + - description: ECID (Enhanced Cell ID) - セル ID (LTE 用) - `ecid` もしくは `eci` のいずれかを指定してください。どちらに値を指定しても結果は同一です。 example: 44668480 in: query name: eci @@ -729,9 +670,9 @@ paths: updated: 2022-01-01T00:00:00:000Z schema: $ref: '#/components/schemas/CellLocation' - description: 基地局の位置情報 + description: 基地局の位置情報。 "404": - description: 指定された基地局の位置情報が見つからない + description: 指定された基地局の位置情報が見つからない。 security: - api_key: [] api_token: [] @@ -741,7 +682,7 @@ paths: x-soracom-cli: - cell-locations get post: - description: 基地局情報のリストから、それらの基地局の位置情報（緯度経度）のリストを取得します。 3G の場合は MCC, MNC, LAC, + description: 基地局情報のリストから、それらの基地局の位置情報 (緯度経度) のリストを取得します。 3G の場合は MCC, MNC, LAC, CID を指定してください。CID がなくてもおおよその位置を取得することができますが、精度は高くありません。 LTE (4G) の場合は MCC, MNC, TAC, ECID を指定してください。 基地局情報から位置情報への変換には外部のオープンなデータベースを利用していますので、情報が存在していなかったり誤っている場合もあります。 operationId: batchGetCellLocations @@ -763,7 +704,7 @@ paths: items: $ref: '#/components/schemas/CellIdentifier' type: array - description: 基地局情報のリスト + description: 基地局情報のリスト。 required: true responses: "200": @@ -792,7 +733,7 @@ paths: items: $ref: '#/components/schemas/CellLocation' type: array - description: 指定された基地局に対応する位置情報のリスト + description: 指定された基地局に対応する位置情報のリスト。 security: - api_key: [] api_token: [] @@ -821,7 +762,8 @@ paths: x-soracom-cli: - coupons list post: - description: 新規でクーポンの見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。 + description: 新規でクーポンの見積もりの作成を行います。orderId を /coupons/{order_id}/confirm に PUT + すると発注が完了します。 operationId: createCouponQuotation requestBody: content: @@ -925,7 +867,7 @@ paths: description: 認証情報を削除する。 operationId: deleteCredential parameters: - - description: Credentials ID + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -933,9 +875,9 @@ paths: type: string responses: "204": - description: Deleted + description: 認証情報が削除されました。 "404": - description: Not Found + description: 認証情報 ID が見つかりません。 security: - api_key: [] api_token: [] @@ -948,7 +890,7 @@ paths: description: 認証情報を新規作成する。 operationId: createCredential parameters: - - description: credentials_id + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -1002,7 +944,7 @@ paths: $ref: '#/components/examples/MockmockDatarecorderCredentials' schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true responses: "201": @@ -1010,7 +952,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CredentialsModel' - description: Created + description: 認証情報が作成されました。 security: - api_key: [] api_token: [] @@ -1023,7 +965,7 @@ paths: description: 認証情報を更新する。 operationId: updateCredential parameters: - - description: credentials_id + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -1034,7 +976,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true responses: "200": @@ -1108,11 +1050,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前のページで取得した最後のデータエントリのキー。このパラメータを指定することで次のデータエントリを取得できます。 in: query @@ -2022,11 +1966,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -2232,7 +2178,7 @@ paths: description: 診断結果を取得します。 operationId: getDiagnostic parameters: - - description: 診断リクエストの識別子 + - description: 診断リクエストの識別子。 in: path name: diagnostic_id required: true @@ -2260,7 +2206,7 @@ paths: description: イベントハンドラーの一覧を返す。 operationId: listEventHandlers parameters: - - description: target + - description: 監視対象 (イベントを実行する対象)。 in: query name: target required: false @@ -2305,7 +2251,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventHandlerModel' - description: Created + description: イベントハンドラーが作成されました。 security: - api_key: [] api_token: [] @@ -2319,7 +2265,7 @@ paths: description: 指定されたイベントハンドラーを削除する。 operationId: deleteEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2329,7 +2275,7 @@ paths: "204": description: OK. "404": - description: EventHandler not found. + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2342,7 +2288,7 @@ paths: description: 指定されたイベントハンドラーの情報を返す。 operationId: getEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2356,7 +2302,7 @@ paths: $ref: '#/components/schemas/EventHandlerModel' description: OK. "404": - description: Handler not found. + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2370,7 +2316,7 @@ paths: / SORACOM API で作成する](/ja-jp/docs/event-handler/configure-with-api/) を参照してください。 operationId: updateEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2387,7 +2333,7 @@ paths: "200": description: OK. "400": - description: Invalid handlerId. + description: 不正なイベントハンドラー ID が指定されました。 security: - api_key: [] api_token: [] @@ -2398,16 +2344,16 @@ paths: - event-handlers update /event_handlers/{handler_id}/subscribers/{imsi}/ignore: delete: - description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を削除 + description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を削除。 operationId: deleteIgnoreEventHandler parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true schema: type: string - - description: handler_id + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2415,9 +2361,9 @@ paths: type: string responses: "204": - description: OK + description: OK. "404": - description: not found + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2427,16 +2373,16 @@ paths: x-soracom-cli: - event-handlers unignore post: - description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を追加 + description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を追加。 operationId: setIgnoreEventHandler parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true schema: type: string - - description: handler_id + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2444,7 +2390,7 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -2458,7 +2404,7 @@ paths: description: 対象 IMSI に紐づくイベントハンドラーのリストを返す。 operationId: listEventHandlersBySubscriber parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true @@ -2474,7 +2420,7 @@ paths: type: array description: OK. "404": - description: not found + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2631,11 +2577,20 @@ paths: type: string responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FileEntry' description: 指定されたファイルのメタデータ + headers: + Content-Length: + description: ファイルのサイズ（バイト） + schema: + type: integer + Content-Type: + description: ファイルの Content-Type + schema: + type: string + ETag: + description: ファイルのバージョンを表す識別子 + schema: + type: string "404": description: 指定されたファイルが見つからない security: @@ -2830,10 +2785,10 @@ paths: operationId: listGadgets parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 取得対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: query name: product_id required: false @@ -2856,10 +2811,10 @@ paths: schema: type: string - description: | - タグの値の検索条件 + タグの値の検索条件。 - - `exact`: 完全一致 - - `prefix`: 前方一致 + - `exact`: 完全一致。 + - `prefix`: 前方一致。 in: query name: tag_value_match_mode required: false @@ -2869,7 +2824,7 @@ paths: - exact - prefix type: string - - description: 取得する Gadget API 対応デバイスのデータの件数 (上限) + - description: 取得する Gadget API 対応デバイスのデータの件数 (上限)。 in: query name: limit required: false @@ -2915,7 +2870,7 @@ paths: items: $ref: '#/components/schemas/Gadget' type: array - description: 条件に一致する Gadget API 対応デバイスのデータのリスト + description: 条件に一致する Gadget API 対応デバイスのデータのリスト。 security: - api_key: [] api_token: [] @@ -2935,10 +2890,10 @@ paths: operationId: getGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -2947,7 +2902,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -2980,9 +2935,9 @@ paths: terminationEnabled: false schema: $ref: '#/components/schemas/Gadget' - description: 指定された Gadget API 対応デバイスの詳細情報 + description: 指定された Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -2997,10 +2952,10 @@ paths: operationId: disableTerminationOnGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3009,7 +2964,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3021,9 +2976,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3038,10 +2993,10 @@ paths: operationId: enableTerminationOnGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3050,7 +3005,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3062,9 +3017,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3075,14 +3030,14 @@ paths: - gadgets enable-termination /gadgets/{product_id}/{serial_number}/register: post: - description: Gadget API 対応デバイスを登録する + description: Gadget API 対応デバイスを登録する。 operationId: registerGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3091,7 +3046,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3102,7 +3057,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GadgetRegistrationRequest' - description: Gadget の登録リクエスト + description: Gadget の登録リクエスト。 required: true responses: "200": @@ -3110,9 +3065,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: Gadget API 対応デバイスが正しく登録されました + description: Gadget API 対応デバイスが正しく登録されました。 "404": - description: 指定された Gadget API 対応デバイスが存在しません + description: 指定された Gadget API 対応デバイスが存在しません。 security: - api_key: [] api_token: [] @@ -3127,10 +3082,10 @@ paths: operationId: putGadgetTags parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3139,7 +3094,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3152,7 +3107,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -3160,9 +3115,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3177,10 +3132,10 @@ paths: operationId: deleteGadgetTag parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3189,14 +3144,14 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -3204,9 +3159,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された Gadget API 対応デバイスあるいはタグが存在しない + description: 指定された Gadget API 対応デバイスあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -3222,10 +3177,10 @@ paths: operationId: terminateGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3234,7 +3189,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3246,9 +3201,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3275,7 +3230,7 @@ paths: required: false schema: type: string - - description: タグの文字列 (`tag_value`) に対する検索条件 + - description: タグの文字列 (`tag_value`) に対する検索条件。 in: query name: tag_value_match_mode required: false @@ -3285,7 +3240,7 @@ paths: - exact - prefix type: string - - description: レスポンス 1 ページあたりの最大数 + - description: レスポンス 1 ページあたりの最大数。 in: query name: limit required: false @@ -3305,7 +3260,7 @@ paths: items: $ref: '#/components/schemas/Group' type: array - description: Group の一覧 + description: Group の一覧。 security: - api_key: [] api_token: [] @@ -3320,19 +3275,47 @@ paths: response: header: x-soracom-next-key post: - description: Group を新規作成する + description: Group を新規作成する。 operationId: createGroup requestBody: content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + tags: + name: Group name schema: $ref: '#/components/schemas/CreateGroupRequest' - description: グループに付けるタグ + description: グループに付けるタグと、グループの設定。 required: true responses: "201": content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + createdAt: 1698796800000 + createdTime: 1698796800000 + groupId: 12345678-abcd-9012-efab-345678901234 + lastModifiedAt: 1698796800000 + lastModifiedTime: 1698796800000 + operatorId: OP0012345678 + tags: + name: Group name schema: $ref: '#/components/schemas/Group' description: Created @@ -3346,10 +3329,10 @@ paths: - groups create /groups/{group_id}: delete: - description: Group ID で指定された Group を削除する + description: Group ID で指定された Group を削除する。 operationId: deleteGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3357,22 +3340,22 @@ paths: type: string responses: "204": - description: 指定された Group を削除完了 + description: 指定された Group を削除完了。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] - summary: Delete Group + summary: グループを削除する tags: - Group x-soracom-cli: - groups delete get: - description: Group ID で指定された Group を返す + description: Group ID で指定された Group を返す。 operationId: getGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3384,9 +3367,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 指定された Group + description: 指定された Group。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] @@ -3397,16 +3380,16 @@ paths: - groups get /groups/{group_id}/configuration/{namespace}: delete: - description: 指定された Group のネームスペースを削除 + description: 指定された Group のネームスペースを削除。 operationId: deleteConfigurationNamespace parameters: - - description: 対象の Group + - description: 対象の Group。 in: path name: group_id required: true schema: type: string - - description: 削除対象のネームスペース + - description: 削除対象のネームスペース。 in: path name: namespace required: true @@ -3415,6 +3398,7 @@ paths: - SoracomAir - SoracomBeam - SoracomEndorse + - SoracomOrbit - SoracomFunk - SoracomFunnel - SoracomHarvest @@ -3424,11 +3408,11 @@ paths: type: string responses: "204": - description: 指定されたネームスペースの削除完了 + description: 指定されたネームスペースの削除完了。 "400": - description: 指定されたネームスペースが存在しない + description: 指定されたネームスペースが存在しない。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3438,7 +3422,7 @@ paths: x-soracom-cli: - groups delete-config-namespace put: - description: 指定された Group のパラメータを追加・更新 + description: 指定された Group のパラメータを追加・更新。 operationId: putConfigurationParameters parameters: - description: 対象の Group の ID。[`Group:listGroups API`](#/Group/listGroups) で取得できます。 @@ -3447,7 +3431,7 @@ paths: required: true schema: type: string - - description: 対象の Configuration + - description: 対象の Configuration。 in: path name: namespace required: true @@ -3516,9 +3500,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 更新後の Group + description: 更新後の Group。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3529,16 +3513,16 @@ paths: - groups put-config /groups/{group_id}/configuration/{namespace}/{name}: delete: - description: 指定された Group のパラメータを削除 + description: 指定された Group のパラメータを削除。 operationId: deleteConfigurationParameter parameters: - - description: 対象の Group + - description: 対象の Group。 in: path name: group_id required: true schema: type: string - - description: 対象のパラメータのネームスペース + - description: 対象のパラメータのネームスペース。 in: path name: namespace required: true @@ -3554,8 +3538,8 @@ paths: - SoracomKrypton - UnifiedEndpoint type: string - - description: 削除対象のパラメータ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら - encodeURIComponent() したものを指定する） + - description: 削除対象のパラメータ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript + なら encodeURIComponent() したものを指定する)。 in: path name: name required: true @@ -3563,9 +3547,9 @@ paths: type: string responses: "204": - description: 指定されたパラメータの削除完了 + description: 指定されたパラメータの削除完了。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3576,16 +3560,16 @@ paths: - groups delete-config /groups/{group_id}/subscribers: get: - description: Group ID で指定された Group に属する Subscriber の一覧を返す + description: Group ID で指定された Group に属する Subscriber の一覧を返す。 operationId: listSubscribersInGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true schema: type: string - - description: レスポンス 1 ページあたりの最大数 + - description: レスポンス 1 ページあたりの最大数。 in: query name: limit required: false @@ -3602,10 +3586,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Group' - description: 指定された Group + items: + $ref: '#/components/schemas/Sim' + type: array + description: 指定された Group。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] @@ -3622,10 +3608,10 @@ paths: header: x-soracom-next-key /groups/{group_id}/tags: put: - description: 指定された Configuration Group のタグを追加・更新 + description: 指定された Configuration Group のタグを追加・更新。 operationId: putGroupTags parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3638,7 +3624,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 更新対象のタグの配列 + description: 更新対象のタグの配列。 required: true responses: "200": @@ -3646,9 +3632,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 更新後の Group + description: 更新後の Group。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3660,17 +3646,17 @@ paths: - groups put-tags /groups/{group_id}/tags/{tag_name}: delete: - description: 指定された Group のタグを削除 + description: 指定された Group のタグを削除。 operationId: deleteGroupTag parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -3678,9 +3664,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定されたグループあるいはタグが存在しない + description: 指定されたグループあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -3698,7 +3684,7 @@ paths: **Warning**: この API では、SORACOM Lagoon 3 の Dashboard の権限は更新できません。 operationId: updateLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: 対象の Dashboard の ID。 in: path name: dashboard_id required: true @@ -3718,15 +3704,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonDashboardPermissionsUpdatingRequest' - description: req + description: リクエスト。 required: true responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Unauthorized operation + description: 許可されていません。 security: - api_key: [] api_token: [] @@ -3743,7 +3729,7 @@ paths: **Warning**: この API では、SORACOM Lagoon 3 の Dashboard の権限は初期化できません。 operationId: initializeLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: 対象の Dashboard の ID。 in: path name: dashboard_id required: true @@ -3760,11 +3746,11 @@ paths: type: boolean responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Unauthorized operation + description: 許可されていません。 security: - api_key: [] api_token: [] @@ -3797,9 +3783,9 @@ paths: items: $ref: '#/components/schemas/LagoonDashboardPermissionsResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3827,9 +3813,9 @@ paths: application/json: schema: type: string - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3840,7 +3826,7 @@ paths: - lagoon get-image-link /lagoon/license_packs: get: - description: SORACOM Lagoon のライセンスパックのステータスを取得します + description: SORACOM Lagoon のライセンスパックのステータスを取得します。 operationId: listLagoonLicensePackStatus responses: "200": @@ -3850,9 +3836,9 @@ paths: items: $ref: '#/components/schemas/LagoonLicensePackStatusResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3872,15 +3858,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonLicensePacksUpdatingRequest' - description: req + description: リクエスト。 required: true responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator Not Found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -3897,7 +3883,7 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "200": - description: OK. The response body contains the Lagoon migration information. + description: SORACOM Lagoon のバージョン移行に関連する情報。 security: - api_key: [] api_token: [] @@ -3914,11 +3900,11 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonMigrationRequest' - description: req + description: リクエスト。 required: true responses: "200": - description: OK. It has finished the Lagoon migration. + description: SORACOM Lagoon のバージョン移行が完了しました。 security: - api_key: [] api_token: [] @@ -3938,11 +3924,11 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator Not Found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -3963,7 +3949,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationRequest' - description: request + description: リクエスト。 required: true responses: "201": @@ -3971,9 +3957,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationResponse' - description: Registered + description: 利用が開始されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3991,11 +3977,11 @@ paths: operationId: terminateLagoon responses: "204": - description: Terminated + description: 解約されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator not found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -4025,9 +4011,9 @@ paths: items: $ref: '#/components/schemas/LagoonUser' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4045,7 +4031,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationRequest' - description: request + description: リクエスト。 required: true responses: "201": @@ -4053,9 +4039,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationResponse' - description: Created + description: 作成されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4070,7 +4056,7 @@ paths: description: SORACOM Lagoon のユーザーを削除します。 operationId: deleteLagoonUser parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4078,9 +4064,9 @@ paths: type: integer responses: "204": - description: Deleted + description: 削除されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4095,7 +4081,7 @@ paths: description: SORACOM Lagoon のユーザーのメールアドレスを変更します。 operationId: updateLagoonUserEmail parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4106,13 +4092,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserEmailUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4127,7 +4113,7 @@ paths: description: SORACOM Lagoon のユーザーのパスワードを変更します。 operationId: updateLagoonUserPassword parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4138,13 +4124,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPasswordUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4159,7 +4145,7 @@ paths: description: SORACOM Lagoon のユーザーの権限を変更します。 operationId: updateLagoonUserPermission parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4170,13 +4156,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPermissionUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4192,7 +4178,7 @@ paths: 条件に合うログエントリのリストを返す。ログエントリの総数が 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: getLogs parameters: - - description: ログ取得対象のリソースのタイプ + - description: ログ取得対象のリソースのタイプ。 in: query name: resource_type required: false @@ -4202,13 +4188,13 @@ paths: - EventHandler - VirtualPrivateGateway type: string - - description: ログ取得対象のリソースの ID + - description: ログ取得対象のリソースの ID。 in: query name: resource_id required: false schema: type: string - - description: ログエントリをフィルタするためのサービス名 + - description: ログエントリをフィルタするためのサービス名。 in: query name: service required: false @@ -4223,19 +4209,19 @@ paths: - Funnel - Gate type: string - - description: ログ取得対象の期間の始まり (unixtime) + - description: ログ取得対象の期間の始まり (UNIX 時間 (ミリ秒))。 in: query name: from required: false schema: type: integer - - description: ログ取得対象の期間の終わり (unixtime) + - description: ログ取得対象の期間の終わり (UNIX 時間 (ミリ秒))。 in: query name: to required: false schema: type: integer - - description: 取得するログエントリ数の上限 + - description: 取得するログエントリ数の上限。 in: query name: limit required: false @@ -4255,7 +4241,7 @@ paths: items: $ref: '#/components/schemas/LogEntry' type: array - description: ログエントリのリスト + description: ログエントリのリスト。 security: - api_key: [] api_token: [] @@ -4394,11 +4380,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -4718,7 +4706,7 @@ paths: 条件に合う LoRAWAN ゲートウェイを取得します。LoRaWAN ゲートウェイが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listLoraGateways parameters: - - description: 検索対象にするタグの名前(完全一致)。 + - description: 検索対象にするタグの名前 (完全一致)。 in: query name: tag_name required: false @@ -4740,7 +4728,7 @@ paths: - exact - prefix type: string - - description: 一度に取得する LoRaWAN ゲートウェイの数の上限 + - description: 一度に取得する LoRaWAN ゲートウェイの数の上限。 in: query name: limit required: false @@ -4761,7 +4749,7 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: LoRaWAN ゲートウェイのリスト + description: LoRaWAN ゲートウェイのリスト。 security: - api_key: [] api_token: [] @@ -4792,9 +4780,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 指定された LoRaWAN ゲートウェイの詳細情報 + description: 指定された LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4805,10 +4793,10 @@ paths: - lora-gateways get /lora_gateways/{gateway_id}/disable_termination: post: - description: 指定された LoRaWAN ゲートウェイを Terminate 不可能に設定する + description: 指定された LoRaWAN ゲートウェイを Terminate 不可能に設定する。 operationId: disableTerminationOnLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4820,9 +4808,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4833,10 +4821,10 @@ paths: - lora-gateways disable-termination /lora_gateways/{gateway_id}/enable_termination: post: - description: 指定された LoRaWAN ゲートウェイを Terminate 可能に設定する + description: 指定された LoRaWAN ゲートウェイを Terminate 可能に設定する。 operationId: enableTerminationOnLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4848,9 +4836,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4861,10 +4849,10 @@ paths: - lora-gateways enable-termination /lora_gateways/{gateway_id}/set_network_set: post: - description: 指定された LoRaWAN ゲートウェイの Network Set ID を指定あるいは上書き変更 + description: 指定された LoRaWAN ゲートウェイの Network Set ID を指定あるいは上書き変更。 operationId: setLoraNetworkSet parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4875,16 +4863,16 @@ paths: text/plain: schema: $ref: '#/components/schemas/SetNetworkSetRequest' - description: LoRaWAN ネットワーク ID + description: LoRaWAN ネットワーク ID。 responses: "200": content: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4895,10 +4883,10 @@ paths: - lora-gateways set-network-set /lora_gateways/{gateway_id}/tags: put: - description: 指定された LoRaWAN ゲートウェイのタグを追加・更新 + description: 指定された LoRaWAN ゲートウェイのタグを追加・更新。 operationId: putLoraGatewayTags parameters: - - description: 対象の LoRaWAN デバイスの ID + - description: 対象の LoRaWAN デバイスの ID。 in: path name: gateway_id required: true @@ -4911,7 +4899,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -4919,9 +4907,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4932,17 +4920,17 @@ paths: - lora-gateways put-tags /lora_gateways/{gateway_id}/tags/{tag_name}: delete: - description: 指定された LoRaWAN ゲートウェイのタグを削除 + description: 指定された LoRaWAN ゲートウェイのタグを削除。 operationId: deleteLoraGatewayTag parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -4950,9 +4938,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された LoRaWAN ゲートウェイあるいはタグが存在しない + description: 指定された LoRaWAN ゲートウェイあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -4963,10 +4951,10 @@ paths: - lora-gateways delete-tag /lora_gateways/{gateway_id}/terminate: post: - description: 指定された LoRaWAN ゲートウェイを Terminate + description: 指定された LoRaWAN ゲートウェイを Terminate。 operationId: terminateLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4978,9 +4966,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4991,10 +4979,10 @@ paths: - lora-gateways terminate /lora_gateways/{gateway_id}/unset_network_set: post: - description: 指定された LoRaWAN ゲートウェイの Network Set ID を削除 + description: 指定された LoRaWAN ゲートウェイの Network Set ID を削除。 operationId: unsetLoraNetworkSet parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -5006,9 +4994,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -5023,7 +5011,7 @@ paths: 条件に合う LoRAWAN ネットワークを取得します。LoRaWAN ネットワークが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listLoraNetworkSets parameters: - - description: 検索対象にするタグの名前(完全一致)。 + - description: 検索対象にするタグの名前 (完全一致)。 in: query name: tag_name required: false @@ -5045,7 +5033,7 @@ paths: - exact - prefix type: string - - description: 一度に取得する LoRaWAN ネットワークの数の上限 + - description: 一度に取得する LoRaWAN ネットワークの数の上限。 in: query name: limit required: false @@ -5066,7 +5054,7 @@ paths: items: $ref: '#/components/schemas/LoraNetworkSet' type: array - description: LoRaWAN ネットワークのリスト + description: LoRaWAN ネットワークのリスト。 security: - api_key: [] api_token: [] @@ -5081,14 +5069,14 @@ paths: response: header: x-soracom-next-key post: - description: LoRaWAN ネットワークを作成する + description: LoRaWAN ネットワークを作成する。 operationId: createLoraNetworkSet requestBody: content: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: タグなど作成対象の LoRaWAN ネットワークに設定する付加情報 + description: タグなど作成対象の LoRaWAN ネットワークに設定する付加情報。 required: true responses: "201": @@ -5096,7 +5084,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: LoRaWAN ネットワークの作成に成功. + description: LoRaWAN ネットワークの作成に成功。 security: - api_key: [] api_token: [] @@ -5107,10 +5095,10 @@ paths: - lora-network-sets create /lora_network_sets/{ns_id}: delete: - description: 指定された LoRaWAN ネットワークを削除する + description: 指定された LoRaWAN ネットワークを削除する。 operationId: deleteLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5118,9 +5106,9 @@ paths: type: string responses: "204": - description: 削除に成功 + description: 削除に成功。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5130,10 +5118,10 @@ paths: x-soracom-cli: - lora-network-sets delete get: - description: 指定された LoRaWAN ネットワークの情報を返す + description: 指定された LoRaWAN ネットワークの情報を返す。 operationId: getLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5145,9 +5133,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: LoRaWAN ネットワークの詳細情報を取得完了 + description: LoRaWAN ネットワークの詳細情報を取得完了。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5161,7 +5149,7 @@ paths: description: 別の Operator から LoRaWAN ネットワークが利用できるようにパーミッションを追加する。 operationId: addPermissionToLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5172,7 +5160,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePermissionRequest' - description: 許可された Operator のリストに追加すべき Operator の ID + description: 許可された Operator のリストに追加すべき Operator の ID。 required: true responses: "200": @@ -5180,7 +5168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 指定された LoRaWAN ネットワークのパーミッションを更新完了 + description: 指定された LoRaWAN ネットワークのパーミッションを更新完了。 security: - api_key: [] api_token: [] @@ -5195,13 +5183,13 @@ paths: 指定された LoRAWAN ネットワークに属する LoRaWAN ゲートウェイを取得します。LoRaWAN ゲートウェイが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listGatewaysInLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true schema: type: string - - description: 一度に取得する LoRaWAN ゲートウェイの数の上限 + - description: 一度に取得する LoRaWAN ゲートウェイの数の上限。 in: query name: limit required: false @@ -5222,9 +5210,9 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: LoRaWAN ゲートウェイのリスト + description: LoRaWAN ゲートウェイのリスト。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5240,10 +5228,10 @@ paths: header: x-soracom-next-key /lora_network_sets/{ns_id}/revoke_permission: post: - description: 指定された LoRaWAN ネットワークの別の Operator への利用許可を取り消す + description: 指定された LoRaWAN ネットワークの別の Operator への利用許可を取り消す。 operationId: revokePermissionFromLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5254,7 +5242,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePermissionRequest' - description: 許可された Operator のリストに追加すべき Operator の ID + description: 許可された Operator のリストに追加すべき Operator の ID。 required: true responses: "200": @@ -5262,7 +5250,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 指定された LoRaWAN ネットワークのパーミッションを更新完了 + description: 指定された LoRaWAN ネットワークのパーミッションを削除完了。 security: - api_key: [] api_token: [] @@ -5273,10 +5261,10 @@ paths: - lora-network-sets revoke-permission /lora_network_sets/{ns_id}/tags: put: - description: 指定された LoRaWAN ネットワークのタグを追加・更新 + description: 指定された LoRaWAN ネットワークのタグを追加・更新。 operationId: putLoraNetworkSetTags parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5289,7 +5277,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -5297,9 +5285,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 更新後の LoRaWAN ネットワークの詳細情報 + description: 更新後の LoRaWAN ネットワークの詳細情報。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5310,17 +5298,17 @@ paths: - lora-network-sets put-tag /lora_network_sets/{ns_id}/tags/{tag_name}: delete: - description: 指定された LoRaWAN ネットワークのタグを削除 + description: 指定された LoRaWAN ネットワークのタグを削除。 operationId: deleteLoraNetworkSetTag parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -5328,9 +5316,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された LoRaWAN ネットワークあるいはタグが存在しない + description: 指定された LoRaWAN ネットワークあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -5339,36 +5327,12 @@ paths: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete-tag - /operators: - post: - description: Operator の新規登録をリクエストする。パラメータで指定されたメールアドレスに宛てて、Operator 登録確認用のワンタイムトークンを含んだメールが送信される。 - operationId: createOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterOperatorsRequest' - description: email, password - required: true - responses: - "201": - description: Operator が作成された - "400": - description: メールアドレスがすでに登録されているか、パスワードのフォーマットが不正 - security: - - api_key: [] - api_token: [] - summary: オペレーターを新規作成する - tags: - - Operator - x-soracom-cli: - - operator create /operators/{operator_id}: get: description: Operator の情報を返す。 operationId: getOperator parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5382,7 +5346,7 @@ paths: $ref: '#/components/schemas/GetOperatorResponse' description: OK. "400": - description: Invalid Operator Id + description: 誤ったオペレーター ID が指定されました。 security: - api_key: [] api_token: [] @@ -5396,7 +5360,7 @@ paths: description: オペレーターの認証キー一覧を返す。 operationId: listOperatorAuthKeys parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5423,7 +5387,7 @@ paths: description: オペレーターの認証キーを生成する。 operationId: generateOperatorAuthKey parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5449,13 +5413,13 @@ paths: description: オペレーターの認証キーを削除する。 operationId: deleteOperatorAuthKey parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: auth_key_id + - description: 認証キー ID。 in: path name: auth_key_id required: true @@ -5477,7 +5441,7 @@ paths: description: オペレーターの契約者情報 (法人) を返す。 operationId: getCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5499,10 +5463,10 @@ paths: x-soracom-cli: - operator get-company-information post: - description: オペレーターの契約者情報 (法人) を設定する。 + description: オペレーターの契約者情報 (法人) を作成する。 operationId: createCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5513,15 +5477,15 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: オペレーターの契約者情報 (法人)。 required: true responses: "201": - description: Created. + description: 作成されました。 security: - api_key: [] api_token: [] - summary: オペレーターの契約者情報 (法人) を設定する + summary: オペレーターの契約者情報 (法人) を作成する tags: - Operator x-soracom-cli: @@ -5530,7 +5494,7 @@ paths: description: オペレーターの契約者情報 (法人) を更新する。 operationId: updateCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5541,7 +5505,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: オペレーターの契約者情報 (法人)。 required: true responses: "200": @@ -5559,25 +5523,23 @@ paths: description: オペレーターに設定された指定のコンフィグレーションを削除します。 operationId: deleteOperatorConfigurationNamespace parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true schema: type: string responses: - "200": - description: OK. "204": - description: Deleted. + description: 削除されました。 "400": - description: Bad request. + description: 不正なリクエストです。 "404": description: コンフィグレーションが存在しません。 security: @@ -5592,13 +5554,13 @@ paths: description: オペレーターに設定された指定のコンフィグレーションを返します。 operationId: getOperatorConfigurationNamespace parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true @@ -5633,7 +5595,7 @@ paths: required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true @@ -5669,7 +5631,7 @@ paths: description: Operator のオプション契約を追加する。 operationId: addOperatorContract parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5680,7 +5642,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContractUpdatingRequest' - description: model + description: モデル。 required: true responses: "200": @@ -5702,13 +5664,13 @@ paths: description: Opearator のオプション契約を解除する。 operationId: deleteOperatorContract parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: contract_name + - description: オプション契約の名前。 in: path name: contract_name required: true @@ -5716,7 +5678,7 @@ paths: type: string responses: "204": - description: No Content. + description: 削除されました。 security: - api_key: [] api_token: [] @@ -5730,13 +5692,13 @@ paths: description: Operator に新規のカバレッジタイプを追加する。 operationId: addCoverageType parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: coverage_type + - description: カバレッジタイプ。 in: path name: coverage_type required: true @@ -5744,7 +5706,7 @@ paths: type: string responses: "201": - description: Created. + description: 追加されました。 security: - api_key: [] api_token: [] @@ -5758,7 +5720,7 @@ paths: description: メールアドレスの一覧を返す。 operationId: listEmails parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5789,13 +5751,13 @@ paths: description: メールアドレスを削除する。 operationId: deleteEmail parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: email_id + - description: メールアドレス ID。 in: path name: email_id required: true @@ -5803,7 +5765,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -5816,13 +5778,13 @@ paths: description: メールアドレスの情報を取得する。 operationId: getEmail parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: email_id + - description: メールアドレス ID。 in: path name: email_id required: true @@ -5848,7 +5810,7 @@ paths: description: オペレーターの契約者情報 (個人) を取得します。 operationId: getIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5870,10 +5832,10 @@ paths: x-soracom-cli: - operator get-individual-information post: - description: オペレーターの契約者情報 (個人) を設定する。 + description: オペレーターの契約者情報 (個人) を作成する。 operationId: createIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5884,15 +5846,15 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: オペレーターの契約者情報 (個人)。 required: true responses: "201": - description: Created. + description: 作成されました。 security: - api_key: [] api_token: [] - summary: オペレーターの契約者情報 (個人) を設定する + summary: オペレーターの契約者情報 (個人) を作成する tags: - Operator x-soracom-cli: @@ -5901,7 +5863,7 @@ paths: description: オペレーターの契約者情報 (個人) を更新する。 operationId: updateIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5912,7 +5874,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: オペレーターの契約者情報 (個人)。 required: true responses: "200": @@ -5930,7 +5892,7 @@ paths: description: ルートユーザーの MFA を無効化します。 operationId: revokeMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5960,7 +5922,7 @@ paths: のいずれかです。 operationId: getMFAStatus parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5972,9 +5934,9 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAStatusOfUseResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -5988,7 +5950,7 @@ paths: MFA OTP を検証する必要があります。 operationId: enableMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6000,9 +5962,9 @@ paths: application/json: schema: $ref: '#/components/schemas/EnableMFAOTPResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -6013,11 +5975,11 @@ paths: - operator enable-mfa /operators/{operator_id}/mfa/verify: post: - description: ルートユーザーの MFA OTP を検証します。 `Operator:enableMFA` を呼んだ後に呼び出す必要があります。この + description: ルートユーザーの MFA OTP を検証します。`Operator:enableMFA` を呼んだ後に呼び出す必要があります。この API で正しく検証が行われるまで、MFA は有効になりません。この API のレスポンスとして返ってくるバックアップコードは必ず保管してください。 operationId: verifyMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6028,7 +5990,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAAuthenticationRequest' - description: request + description: リクエスト。 required: true responses: "200": @@ -6036,9 +5998,9 @@ paths: application/json: schema: $ref: '#/components/schemas/OperatorMFAVerifyingResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -6063,13 +6025,13 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePasswordRequest' - description: current password, new password + description: 現在のパスワードと新しいパスワード。 required: true responses: "200": description: OK. "400": - description: Invalid password. + description: 不正なパスワードです。 security: - api_key: [] api_token: [] @@ -6083,7 +6045,7 @@ paths: description: ロールの一覧を返す。 operationId: listRoles parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6111,13 +6073,13 @@ paths: description: ロールを削除する。 operationId: deleteRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6142,13 +6104,13 @@ paths: description: ロールを取得する。 operationId: getRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6175,13 +6137,13 @@ paths: description: ロールを新しく追加する。 operationId: createRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6192,7 +6154,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: パーミッション。 required: true responses: "200": @@ -6215,13 +6177,13 @@ paths: description: ロールを編集する。 operationId: updateRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6232,11 +6194,11 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: パーミッション。 required: true responses: "200": - description: OK + description: OK. "404": description: ロールが見つかりません。 security: @@ -6252,13 +6214,13 @@ paths: description: ロールに紐づく SAM ユーザーの一覧を取得する。 operationId: listRoleAttachedUsers parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6288,7 +6250,7 @@ paths: description: 商品発送先の一覧を返します。 operationId: listShippingAddresses parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6313,7 +6275,7 @@ paths: description: 商品発送先を新規登録する。 operationId: createShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6324,7 +6286,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: 商品発送先。 required: true responses: "201": @@ -6346,13 +6308,13 @@ paths: description: 商品発送先を削除する。 operationId: deleteShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6360,7 +6322,7 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6373,13 +6335,13 @@ paths: description: 商品発送先を返す。 operationId: getShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6404,13 +6366,13 @@ paths: description: 商品発送先を更新する。 operationId: updateShippingAddress parameters: - - description: Operator ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6421,11 +6383,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: 商品発送先。 required: true responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6439,7 +6401,7 @@ paths: description: サポート画面アクセス用のトークンを返す。 operationId: generateSupportToken parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6453,9 +6415,9 @@ paths: $ref: '#/components/schemas/SupportTokenResponse' description: OK. "400": - description: Invalid Operator Id + description: 誤ったオペレーター ID が指定されました。 "403": - description: Invalid token. + description: 不正なトークンです。 security: - api_key: [] api_token: [] @@ -6497,13 +6459,13 @@ paths: description: メールアドレス設定からメールアドレスを削除する。 operationId: deleteSystemNotification parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6515,7 +6477,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6528,13 +6490,13 @@ paths: description: メールアドレス設定を返す。 operationId: getSystemNotification parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6570,7 +6532,7 @@ paths: required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6586,7 +6548,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetSystemNotificationsRequest' - description: request + description: リクエスト。 required: true responses: "200": @@ -6594,7 +6556,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SystemNotificationsModel' - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6609,7 +6571,7 @@ paths: API トークンを用いることができる。 operationId: generateAuthToken parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6620,7 +6582,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GenerateTokenRequest' - description: token timeout seconds + description: API トークンの有効期間 (秒)。 required: true responses: "200": @@ -6634,7 +6596,7 @@ paths: application/json: schema: $ref: '#/components/schemas/APICallError' - description: リクエストに誤りがあるか、指定されたトークンがすでに無効になっている（後者の場合、/auth API で再度認証を行う必要がある） + description: リクエストに誤りがあるか、指定されたトークンがすでに無効になっている (後者の場合、/auth API で再度認証を行う必要がある)。 security: - api_key: [] api_token: [] @@ -6649,7 +6611,7 @@ paths: キーと API トークンを用いて SORACOM API を呼び出すことはできません。 operationId: revokeOperatorAuthTokens parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -7345,13 +7307,13 @@ paths: description: SAM ユーザーのロールの一覧を取得する。 operationId: listUserRoles parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true @@ -7380,13 +7342,13 @@ paths: description: SAM ユーザーにロールをアタッチする。 operationId: attachRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true @@ -7397,11 +7359,11 @@ paths: application/json: schema: $ref: '#/components/schemas/AttachRoleRequest' - description: role_id + description: ロール ID。 required: true responses: "200": - description: OK + description: OK. "400": description: 指定されたロールはすでにアタッチされているか、あるいは存在しません。 "404": @@ -7419,19 +7381,19 @@ paths: description: SAM ユーザーからロールをデタッチする。 operationId: detachRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -7439,7 +7401,7 @@ paths: type: string responses: "200": - description: OK + description: OK. "404": description: SAM ユーザーまたはロールが存在しません。 security: @@ -7548,7 +7510,7 @@ paths: description: | `operator_id` と `user_name` で指定した SAM ユーザーに設定された信頼ポリシーを更新します。 - **Warning**: 信頼ポリシーで設定したオペレーターおよび SAM ユーザーに、`operator_id` と `user_name` で指定した SAM ユーザーに指定された権限が与えられます。権限によっては、セッション履歴、通信量履歴など、このオペレーターに関する機微な情報を参照できることがあります。 + **Warning**: 信頼ポリシーを設定すると、リクエストボディで指定したルートユーザーまたは SAM ユーザー (元のユーザー) が、`operator_id` と `user_name` で指定した SAM ユーザー(スイッチ先のユーザー) にスイッチできるようになります。元のユーザーがスイッチしたときは、元のユーザーに、スイッチ先のユーザーと同じ権限が与えられ、権限によっては、セッション履歴、通信量履歴など、このオペレーターに関する機微な情報を参照できることがあります。 operationId: updateUserTrustPolicy parameters: - description: オペレーター ID。 @@ -7679,11 +7641,11 @@ paths: application/json: schema: $ref: '#/components/schemas/IssueAddEmailTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": description: メール登録数の最大を超過しました。 security: @@ -7703,11 +7665,11 @@ paths: application/json: schema: $ref: '#/components/schemas/VerifyAddEmailTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. summary: メールアドレス追加用のトークンを検証する tags: - Email @@ -7722,15 +7684,15 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAIssueRevokingTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator not found + description: オペレーターが存在しません。 summary: ルートユーザーの MFA を無効化するためのトークンを発行する tags: - Operator @@ -7739,56 +7701,33 @@ paths: /operators/mfa_revoke_token/verify: post: description: MFA を無効化するためのワンタイムトークン、アカウントのメールアドレス、パスワードおよびバックアップコードの組み合わせによって - MFA を無効化します。 + MFA を無効化します。検証に成功すると、MFA が無効化されます。 operationId: verifyMFARevokingToken requestBody: content: application/json: schema: $ref: '#/components/schemas/MFARevokingTokenVerifyRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: Revoked + description: 無効化されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Invalid username or password + description: メールアドレスまたはパスワードが誤っています。 summary: ルートユーザーの MFA を無効化するためのトークンを検証して MFA を無効化する tags: - Operator x-soracom-cli: - operator verify-mfa-revoke-token - /operators/verify: - post: - description: Operator 登録の確認を行う。メールで送られてくる確認用ワンタイムトークンをパラメータに含めて呼び出しを行う。 - operationId: verifyOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VerifyOperatorsRequest' - description: token - required: true - responses: - "200": - description: 登録成功 - "400": - description: ワンタイムトークンが不正 - "404": - description: ワンタイムトークンが期限切れ - summary: オペレーター登録を確認する - tags: - - Operator - x-soracom-cli: - - operator verify /orders: get: description: | 発注確定済みの注文履歴の一覧を取得します。 - **Warning**: 取得できる注文履歴は、過去 18 か月までです。それ以前の注文履歴が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listOrders responses: "200": @@ -7806,7 +7745,7 @@ paths: x-soracom-cli: - orders list post: - description: 新規で発注見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。 + description: 新規で発注見積もりの作成を行います。orderId を /orders/{order_id}/confirm に PUT すると発注が完了します。 operationId: createQuotation requestBody: content: @@ -7835,7 +7774,7 @@ paths: description: | 発注確定済みの注文履歴を 1 件だけ取得します。 - **Warning**: 取得できる注文履歴は、過去 18 か月までです。それ以前の注文履歴が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getOrder parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7887,7 +7826,10 @@ paths: - orders cancel /orders/{order_id}/confirm: put: - description: 与信を実施し、問題ない場合に発注を確定します。 + description: | + 与信を実施し、問題ない場合に発注を確定します。 + + **Warning**: 確定できる発注は、過去 1 か月までに完了した発注のみです。1 か月を経過した場合は、発注操作をやり直してください。 operationId: confirmOrder parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7909,7 +7851,10 @@ paths: - orders confirm /orders/{order_id}/resource_initial_setting: put: - description: 発注した商品に対して初期設定を指定します。 + description: | + 発注した商品に対して初期設定を指定します。 + + **Warning**: 受け取り確認後の IoT SIM の初期設定は指定できません。 operationId: updateOrderedResourceInitialSetting parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7946,7 +7891,10 @@ paths: - orders resource-initial-setting update /orders/{order_id}/subscribers: get: - description: 発注した IoT SIM の一覧を返します。 + description: | + 発注した IoT SIM の一覧を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listOrderedSubscribers parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7955,8 +7903,8 @@ paths: required: true schema: type: string - - description: 直前のリクエストで取得したうち、最後の Subscriber の製造番号。レスポンスヘッダの X-Soracom-Next-Key - に含まれる値 + - description: 前ページを取得したときに返された `x-soracom-next-key` ヘッダーに含まれる値。次ページを取得する場合に指定します。詳しくは、[大量のデータを取得する + (ページング)](/ja-jp/tools/api/paging/) を参照してください。 in: query name: last_evaluated_key required: false @@ -7991,7 +7939,10 @@ paths: header: x-soracom-next-key /orders/{order_id}/subscribers/register: post: - description: 発注した IoT SIM をオペレーターに登録します。 + description: | + 発注した IoT SIM をオペレーターに登録します。 + + **Warning**: 登録できる IoT SIM は、過去 18 か月までです。それ以前に発注した IoT SIM を登録する場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: registerOrderedSim parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -8017,7 +7968,10 @@ paths: - orders register-subscribers /payment_history/transactions/{payment_transaction_id}: get: - description: 課金処理の結果を返します。 + description: | + 課金処理の結果を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getPaymentTransaction parameters: - description: 課金処理 ID。[Billing:getBillingHistory API](#/Billing/getBillingHistory) @@ -8090,7 +8044,10 @@ paths: - payment-methods reactivate-current /payment_statements: get: - description: 課金明細の一覧を返します。 + description: | + 課金明細の一覧を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listPaymentStatements responses: "200": @@ -8109,7 +8066,10 @@ paths: - payment-statements list /payment_statements/{payment_statement_id}/export: post: - description: 課金明細を出力します。 + description: | + 課金明細を出力します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: exportPaymentStatement parameters: - description: 課金明細 ID @@ -8193,7 +8153,7 @@ paths: description: オンデマンドリモートアクセスのリストを返します。 operationId: listPortMappings parameters: - - description: 取得結果のページごとの最大表示件数 + - description: 取得結果のページごとの最大表示件数。 in: query name: limit required: false @@ -8213,7 +8173,7 @@ paths: items: $ref: '#/components/schemas/PortMapping' type: array - description: オンデマンドリモートアクセスのリスト + description: オンデマンドリモートアクセスのリスト。 security: - api_key: [] api_token: [] @@ -8235,7 +8195,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatePortMappingRequest' - description: 作成するオンデマンドリモートアクセスの設定 + description: 作成するオンデマンドリモートアクセスの設定。 required: true responses: "201": @@ -8243,7 +8203,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: オンデマンドリモートアクセスが作成された + description: オンデマンドリモートアクセスが作成された。 security: - api_key: [] api_token: [] @@ -8257,13 +8217,13 @@ paths: description: 指定したオンデマンドリモートアクセスを削除します。 operationId: deletePortMapping parameters: - - description: 対象となるオンデマンドリモートアクセスの IP アドレス + - description: 対象となるオンデマンドリモートアクセスの IP アドレス。 in: path name: ip_address required: true schema: type: string - - description: 対象となるオンデマンドリモートアクセスのポート番号 + - description: 対象となるオンデマンドリモートアクセスのポート番号。 in: path name: port required: true @@ -8271,9 +8231,9 @@ paths: type: string responses: "204": - description: 指定したオンデマンドリモートアクセスの削除を完了した + description: 指定したオンデマンドリモートアクセスの削除を完了した。 "404": - description: 指定したオンデマンドリモートアクセスは存在しない + description: 指定したオンデマンドリモートアクセスは存在しない。 security: - api_key: [] api_token: [] @@ -8287,7 +8247,7 @@ paths: description: Subscriber に紐づくオンデマンドリモートアクセスを取得します。 operationId: listPortMappingsForSubscriber parameters: - - description: 対象の Subscriber の IMSI + - description: 対象の Subscriber の IMSI。 in: path name: imsi required: true @@ -8299,9 +8259,9 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: Subscriber に紐づくオンデマンドリモートアクセスのリスト + description: Subscriber に紐づくオンデマンドリモートアクセスのリスト。 "404": - description: 指定した Subscriber は存在しない + description: 指定した Subscriber は存在しない。 security: - api_key: [] api_token: [] @@ -8314,6 +8274,12 @@ paths: get: description: 購入できる商品一覧を取得します。 operationId: listProducts + parameters: + - in: query + name: campaign_code + required: false + schema: + type: string responses: "200": content: @@ -8335,7 +8301,7 @@ paths: SORACOM Inventory デバイスに対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchDevices parameters: - - description: 検索する SORACOM Inventory デバイスの名前 + - description: 検索する SORACOM Inventory デバイスの名前。 explode: true in: query name: name @@ -8344,7 +8310,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8353,7 +8319,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの ID + - description: 検索する SORACOM Inventory デバイスの ID。 explode: true in: query name: deviceId @@ -8362,7 +8328,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8371,7 +8337,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMSI + - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMSI。 explode: true in: query name: imsi @@ -8380,7 +8346,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMEI + - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMEI。 explode: true in: query name: imei @@ -8389,7 +8355,7 @@ paths: items: type: string type: array - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8405,7 +8371,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8423,9 +8389,9 @@ paths: items: $ref: '#/components/schemas/Device' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8445,7 +8411,7 @@ paths: Sigfox デバイスに対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchSigfoxDevices parameters: - - description: 検索する Sigfox デバイスの名前 + - description: 検索する Sigfox デバイスの名前。 explode: true in: query name: name @@ -8454,7 +8420,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8463,7 +8429,7 @@ paths: items: type: string type: array - - description: 検索する Sigfox デバイスの ID + - description: 検索する Sigfox デバイスの ID。 explode: true in: query name: deviceId @@ -8472,7 +8438,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8481,7 +8447,7 @@ paths: items: type: string type: array - - description: 検索する Sigfox デバイスの状態 + - description: 検索する Sigfox デバイスの状態。 in: query name: status required: false @@ -8498,7 +8464,7 @@ paths: - banned - standby type: string - - description: 検索する Sigfox デバイスの登録状態 + - description: 検索する Sigfox デバイスの登録状態。 in: query name: registration required: false @@ -8510,7 +8476,7 @@ paths: - success - failed type: string - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8525,7 +8491,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8543,9 +8509,9 @@ paths: items: $ref: '#/components/schemas/SigfoxDevice' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8651,10 +8617,11 @@ paths: type: string type: array - description: | - セッションの状態 - - `NA`: 任意 - - `ONLINE`: オンライン - - `OFFLINE`: オフライン + セッションの状態。 + + - `NA`: 任意。 + - `ONLINE`: オンライン。 + - `OFFLINE`: オフライン。 in: query name: session_status required: false @@ -8666,7 +8633,7 @@ paths: - OFFLINE format: string type: string - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8699,9 +8666,9 @@ paths: items: $ref: '#/components/schemas/Sim' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8718,11 +8685,11 @@ paths: /query/subscribers: get: deprecated: true - description: (非推奨の API です。代わりに `/query/sims` API を利用することを検討してください) Subscriber + description: (非推奨の API です。代わりに `/query/sims` API を利用することを検討してください。) Subscriber をクエリに応じて検索します。部分一致したものを返却します。この API 権限が付与された場合、すべての SIM に対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchSubscribers parameters: - - description: 検索する Subscriber の名前 + - description: 検索する Subscriber の名前。 explode: true in: query name: name @@ -8731,7 +8698,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8740,7 +8707,7 @@ paths: items: type: string type: array - - description: 検索する IMSI + - description: 検索する IMSI。 explode: true in: query name: imsi @@ -8749,7 +8716,7 @@ paths: items: type: string type: array - - description: 検索する MSISDN + - description: 検索する MSISDN。 explode: true in: query name: msisdn @@ -8758,7 +8725,7 @@ paths: items: type: string type: array - - description: 検索する ICCID + - description: 検索する ICCID。 explode: true in: query name: iccid @@ -8767,7 +8734,7 @@ paths: items: type: string type: array - - description: 検索する製造番号 + - description: 検索する製造番号。 explode: true in: query name: serial_number @@ -8776,7 +8743,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8785,7 +8752,7 @@ paths: items: type: string type: array - - description: '検索するサブスクリプション (例: `plan01s`)' + - description: '検索するサブスクリプション (例: `plan01s`)。' explode: true in: query name: subscription @@ -8794,7 +8761,7 @@ paths: items: type: string type: array - - description: '検索するモジュールタイプ (例: `mini`, `virtual`)' + - description: '検索するモジュールタイプ (例: `mini`, `virtual`)。' explode: true in: query name: module_type @@ -8803,7 +8770,7 @@ paths: items: type: string type: array - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8818,7 +8785,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8836,9 +8803,9 @@ paths: items: $ref: '#/components/schemas/Subscriber' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8858,21 +8825,21 @@ paths: description: 指定された期間の Subscriber の通信量ランキングを検索して返却します。 operationId: searchSubscriberTrafficVolumeRanking parameters: - - description: 検索期間の始点 (UNIX 時間 (ミリ秒)) + - description: 検索期間の始点 (UNIX 時間 (ミリ秒))。 in: query name: from required: true schema: format: int64 type: integer - - description: 検索期間の終点 (UNIX 時間 (ミリ秒)) + - description: 検索期間の終点 (UNIX 時間 (ミリ秒))。 in: query name: to required: true schema: format: int64 type: integer - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8881,7 +8848,7 @@ paths: format: int32 maximum: 500 type: integer - - description: ランキングの順序 + - description: ランキングの順序。 in: query name: order required: false @@ -8899,7 +8866,7 @@ paths: items: $ref: '#/components/schemas/TrafficVolumeRanking' type: array - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -8915,9 +8882,9 @@ paths: operationId: getResourceSummary parameters: - description: | - リソースの要約の種別 + リソースの要約の種別。 - - `simsPerStatus`: ステータスごとの IoT SIM の数 + - `simsPerStatus`: ステータスごとの IoT SIM の数。 in: path name: resource_summary_type required: true @@ -8931,9 +8898,9 @@ paths: application/json: schema: $ref: '#/components/schemas/ResourceSummary' - description: リソースの要約を取得しました + description: リソースの要約を取得しました。 "404": - description: 指定のリソースの要約は存在しません + description: 指定のリソースの要約は存在しません。 security: - api_key: [] api_token: [] @@ -9067,11 +9034,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -9645,11 +9614,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | 前のページで取得した最後のデータエントリのキー。この API でのデータエントリーのキーは、`${UNIX 時間 (ミリ秒)}_${IMSI}` です。このパラメータを指定することで次のデータエントリを取得できます。 @@ -9889,7 +9860,7 @@ paths: header: x-soracom-next-key /sims/{sim_id}/packet_capture_sessions: get: - description: 指定した IoT SIM のパケットキャプチャセッションのリストを取得する。 + description: IoT SIM に対するパケットキャプチャセッションのリストを取得する。 operationId: listSimPacketCaptureSessions parameters: - description: 対象の SIM ID @@ -9920,13 +9891,13 @@ paths: items: $ref: '#/components/schemas/PacketCaptureSession' type: array - description: 指定した IoT SIM のパケットキャプチャセッションのリスト + description: IoT SIM に対するパケットキャプチャセッションのリスト "404": description: 指定した IoT SIM が存在しない security: - api_key: [] api_token: [] - summary: IoT SIM のパケットキャプチャセッションのリストを取得する + summary: IoT SIM に対するパケットキャプチャセッションのリストを取得する tags: - Sim x-soracom-cli: @@ -9937,10 +9908,10 @@ paths: response: header: x-soracom-next-key post: - description: 指定した IoT SIM に対するパケットキャプチャセッションを作成する。 + description: IoT SIM に対するパケットキャプチャセッションを作成する。 operationId: createSimPacketCaptureSession parameters: - - description: パケットキャプチャセッションを作成する IoT SIM の ID + - description: 対象の SIM ID in: path name: sim_id required: true @@ -9959,22 +9930,22 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定した IoT SIM に対して作成されたパケットキャプチャセッション + description: IoT SIM に対するパケットキャプチャセッション "400": - description: 指定した IoT SIM に対するパケットキャプチャセッションの作成が失敗した + description: IoT SIM に対するパケットキャプチャセッションの作成が失敗した "404": description: 指定した IoT SIM が存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを作成する + summary: IoT SIM に対するパケットキャプチャセッションを作成する tags: - Sim x-soracom-cli: - sims create-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}: delete: - description: 指定した IoT SIM に対するパケットキャプチャを削除する。 + description: IoT SIM に対するパケットキャプチャセッションを削除する。 operationId: deleteSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -9997,19 +9968,19 @@ paths: $ref: '#/components/schemas/PacketCaptureSession' description: 削除されたパケットキャプチャセッションの情報 "400": - description: 指定されたパケットキャプチャセッションの削除に失敗 + description: IoT SIM に対するパケットキャプチャセッションの削除に失敗 "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを削除する + summary: IoT SIM に対するパケットキャプチャセッションを削除する tags: - Sim x-soracom-cli: - sims delete-packet-capture-session get: - description: 指定した IoT SIM に対するパケットキャプチャセッションを取得する。 + description: IoT SIM に対するパケットキャプチャセッションを取得する。 operationId: getSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -10030,20 +10001,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定されたパケットキャプチャセッション + description: IoT SIM に対するパケットキャプチャセッション "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを取得する + summary: IoT SIM に対するパケットキャプチャセッションを取得する tags: - Sim x-soracom-cli: - sims get-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}/stop: post: - description: 指定した IoT SIM に対するパケットキャプチャを停止する。 + description: IoT SIM に対するパケットキャプチャセッションを停止する。 operationId: stopSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -10069,13 +10040,13 @@ paths: description: The packet capture session can be stopped only when its status is CAPTURING "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない "500": - description: 指定されたパケットキャプチャセッションが停止できなかった + description: IoT SIM に対するパケットキャプチャセッションが停止できなかった security: - api_key: [] api_token: [] - summary: パケットキャプチャを停止する + summary: IoT SIM に対するパケットキャプチャセッションを停止する tags: - Sim x-soracom-cli: @@ -10477,7 +10448,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetImeiLockRequest' - description: IoT SIM に指定する IMEI lock の設定 (オンラインの IoT SIM の現在の IMEI にロックするには + description: IoT SIM に指定する IMEI ロックの設定 (オンラインの IoT SIM の現在の IMEI にロックするには IMEI は指定しなくてもよい) responses: "200": @@ -10531,6 +10502,83 @@ paths: - Sim x-soracom-cli: - sims set-to-standby + /sims/{sim_id}/statuses/history: + get: + description: IoT SIM のステータス操作履歴を取得します。ステータス操作履歴は、どの IMSI、どのサブスクリプションに対して、どのようなステータス操作を行ったかが操作時間とともに記録されています。速度クラスやグループ + ID、IoT SIM のステータスなどが含まれます。ステータス操作履歴が 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL + が、レスポンスの `link` ヘッダーに含まれます。 + operationId: listSimStatusHistory + parameters: + - description: 対象の IoT SIM の SIM ID。 + in: path + name: sim_id + required: true + schema: + type: string + - description: ステータス操作履歴を取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象の IoT SIM の最も古いステータス操作履歴の発生時刻が設定されます。 + in: query + name: from + required: false + schema: + type: integer + - description: ステータス操作履歴を取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false + schema: + type: integer + - description: 前ページで取得した最後のステータス操作履歴のプライマリ IMSI とタイムスタンプ (UNIX 時間 (ミリ秒)) を `@` + で連結した文字列。このパラメータを指定することで次のステータス操作履歴以降のデータを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: ステータス操作履歴のソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + - description: 取得するステータス操作履歴の上限。ただし、返却されるステータス操作履歴の個数は指定された値を下回る可能性があります。 + in: query + name: limit + required: false + schema: + default: 30 + maximum: 100 + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SimStatusHistoryResponse' + type: array + description: IoT SIM のステータス操作履歴。 + "400": + description: 不正なリクエスト。 + "404": + description: 指定した IoT SIM が存在しない。 + security: + - api_key: [] + api_token: [] + summary: IoT SIM のステータス操作履歴を取得する + tags: + - Sim + x-soracom-cli: + - sims list-status-history + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sims/{sim_id}/suspend: post: description: 指定した IoT SIM のステータスを「利用中断中 (suspended)」に変更する。 @@ -10821,7 +10869,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -10859,108 +10907,58 @@ paths: - SoraCam x-soracom-cli: - sora-cam devices get - /sora_cam/devices/{device_id}/events: + /sora_cam/devices/{device_id}/atomcam/settings: get: description: | - `device_id` で指定したソラカメ対応カメラで検出されたイベントの一覧を取得します。 - operationId: listSoraCamDeviceEventsForDevice + ソラカメ対応カメラの各種設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettings parameters: - - description: 対象のソラカメ対応カメラの ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string - - description: 前回の listSoraCamDeviceEventsForDevice リクエストのレスポンスに含まれていた x-soracom-next-key - ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 - in: query - name: last_evaluated_key - required: false - schema: - type: string - - description: 1 回のリクエストで取得するデータ数の最大値。なお、レスポンスには、指定した最大値よりも少ないデータしか含まれないことがあります。 - in: query - name: limit - required: false - schema: - default: 10 - type: integer - - description: イベントを取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラで検出された最も古いイベントの発生時刻が設定されます。 - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: イベントを取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 - in: query - name: to - required: false - schema: - format: int64 - type: integer - - description: | - イベント一覧のソート順。 - - - `desc`: 降順 (対象のソラカメ対応カメラで検出された最新のイベントが先頭) - - `asc`: 昇順 (対象のソラカメ対応カメラで検出された最も古いイベントが先頭) - in: query - name: sort - required: false - schema: - default: desc - enum: - - desc - - asc - type: string responses: "200": content: application/json: example: - - deviceId: 7CDDDEADBEEF - deviceType: atomCamV2 - eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b - eventInfo: - endTime: 1662973203000 - picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... - recordingStatus: completed - startTime: 1662973200000 - type: motion - time: 1662973200000 - schema: - items: - $ref: '#/components/schemas/SoraCamEvent' - type: array + logo: "on" + motionTagging: "on" + nightVision: auto + quality: high + rotation: 0 + statusLight: "on" + timestamp: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettings' description: OK. - "400": - description: 指定された引数が不正です。 "404": - description: 指定されたソラカメ対応カメラが見つかりませんでした。 + description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラのイベント一覧を取得する + summary: ソラカメ対応カメラの各種設定を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices events list-for-device - x-soracom-cli-pagination: - request: - param: last_evaluated_key - response: - header: x-soracom-next-key - /sora_cam/devices/{device_id}/exports/usage: + - sora-cam devices atomcam get-settings + /sora_cam/devices/{device_id}/atomcam/settings/logo: get: description: | - 静止画の残りのエクスポート可能枚数や、録画映像の残りのエクスポート可能時間などを取得します。 - - **Warning**: 静止画をエクスポートしても、録画映像をエクスポートしても、動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を取得します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: getSoraCamDeviceExportUsage + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsLogo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -10971,70 +10969,102 @@ paths: content: application/json: example: - deviceId: 7CDDDEADBEEF - image: - billedFrames: 0 - limitFrames: 259200 - remainingFrames: 259131 - usedFrames: 69 - meteredYearMonth: "202209" - video: - billedSeconds: 0 - limitSeconds: 259200 - remainingSeconds: 259131 - usedSeconds: 69 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsage' + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' description: OK. "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する + summary: 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices get-export-usage - /sora_cam/devices/{device_id}/exports/usage/limit_override: - delete: + - sora-cam devices atomcam settings get-logo + post: description: | - 動画のエクスポート可能時間の上限をデフォルトの値に戻します。デフォルトは、72 時間です。 + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を変更します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: deleteSoraCamDeviceExportUsageLimitOverride + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsLogo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' responses: - "204": - description: 設定がデフォルトに戻りました。 + "200": + description: OK. + "400": + description: 不正なリクエスト。 "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラの動画のエクスポート可能時間の上限をデフォルトに戻す + summary: 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を変更する tags: - SoraCam x-soracom-cli: - - sora-cam devices delete-export-usage-limit-override - put: + - sora-cam devices atomcam settings set-logo + /sora_cam/devices/{device_id}/atomcam/settings/motion_tagging: + get: description: | - 動画のエクスポート可能時間の上限を変更します。デフォルトは、72 時間です。最大で 1,500 時間まで設定できます。 + モーションタグの表示設定を取得します。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 - **Warning**: 動画のエクスポート可能時間の消費時間が 72 時間を超えると課金が発生します。上限を変更しただけでは、課金は発生しません。動画のエクスポート可能時間の上限の設定にかかわらず、消費時間が 72 時間を超えると課金が発生します。料金について詳しくは、Soracom Cloud Camera Services ソラカメの [料金について](https://soracom.jp/sora_cam/#pricing) を参照してください。 + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - **Warning**: 上限を 72 時間未満に設定することもできます。その場合でも、料金は変わりません。 + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsMotionTagging + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: モーションタグの表示設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-motion-tagging + post: + description: | + モーションタグの表示設定を変更します。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: updateSoraCamDeviceExportUsageLimitOverride + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsMotionTagging parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11044,9 +11074,574 @@ paths: content: application/json: example: - limitHours: 144 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsageLimitOverrideSpecification' + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: モーションタグの表示設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-motion-tagging + /sora_cam/devices/{device_id}/atomcam/settings/night_vision: + get: + description: | + ナイトビジョンモードの設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ナイトビジョンモードの設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-night-vision + post: + description: | + ナイトビジョンモードの設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ナイトビジョンモードの設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-night-vision + /sora_cam/devices/{device_id}/atomcam/settings/quality: + get: + description: | + クラウド録画の画質設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウド録画の画質設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-quality + post: + description: | + クラウド録画の画質設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウド録画の画質設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-quality + /sora_cam/devices/{device_id}/atomcam/settings/rotation: + get: + description: | + 画像を 180° 回転させる設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 画像を 180° 回転させる設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-rotation + post: + description: | + 画像を 180° 回転させる設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 画像を 180° 回転させる設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-rotation + /sora_cam/devices/{device_id}/atomcam/settings/status_light: + get: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-status-light + post: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-status-light + /sora_cam/devices/{device_id}/atomcam/settings/timestamp: + get: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 撮影画像右下に表示されるタイムスタンプの表示設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-timestamp + post: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 撮影画像右下に表示されるタイムスタンプの表示設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-timestamp + /sora_cam/devices/{device_id}/events: + get: + description: | + `device_id` で指定したソラカメ対応カメラで検出されたイベントの一覧を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: listSoraCamDeviceEventsForDevice + parameters: + - description: 対象のソラカメ対応カメラの ID + in: path + name: device_id + required: true + schema: + type: string + - description: 前回の listSoraCamDeviceEventsForDevice リクエストのレスポンスに含まれていた x-soracom-next-key + ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: 1 回のリクエストで取得するデータ数の最大値。なお、レスポンスには、指定した最大値よりも少ないデータしか含まれないことがあります。 + in: query + name: limit + required: false + schema: + default: 10 + type: integer + - description: イベントを取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラで検出された最も古いイベントの発生時刻が設定されます。 + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: イベントを取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + イベント一覧のソート順。 + + - `desc`: 降順 (対象のソラカメ対応カメラで検出された最新のイベントが先頭) + - `asc`: 昇順 (対象のソラカメ対応カメラで検出された最も古いイベントが先頭) + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + responses: + "200": + content: + application/json: + example: + - deviceId: 7CDDDEADBEEF + deviceType: atomCamV2 + eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b + eventInfo: + endTime: 1662973203000 + picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... + recordingStatus: completed + startTime: 1662973200000 + type: motion + time: 1662973200000 + schema: + items: + $ref: '#/components/schemas/SoraCamEvent' + type: array + description: OK. + "400": + description: 指定された引数が不正です。 + "404": + description: 指定されたソラカメ対応カメラが見つかりませんでした。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラのイベント一覧を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key + /sora_cam/devices/{device_id}/exports/usage: + get: + description: | + 静止画の残りのエクスポート可能枚数や、録画映像の残りのエクスポート可能時間などを取得します。 + + **Warning**: 静止画をエクスポートしても、録画映像をエクスポートしても、動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: getSoraCamDeviceExportUsage + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + deviceId: 7CDDDEADBEEF + image: + billedFrames: 0 + limitFrames: 259200 + remainingFrames: 259131 + usedFrames: 69 + meteredYearMonth: "202209" + video: + billedSeconds: 0 + limitSeconds: 259200 + remainingSeconds: 259131 + usedSeconds: 69 + schema: + $ref: '#/components/schemas/SoraCamExportUsage' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-export-usage + /sora_cam/devices/{device_id}/exports/usage/limit_override: + delete: + description: | + 動画のエクスポート可能時間の上限をデフォルトの値に戻します。デフォルトは、72 時間です。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: deleteSoraCamDeviceExportUsageLimitOverride + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "204": + description: 設定がデフォルトに戻りました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの動画のエクスポート可能時間の上限をデフォルトに戻す + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices delete-export-usage-limit-override + put: + description: | + 動画のエクスポート可能時間の上限を変更します。デフォルトは、72 時間です。最大で 1,500 時間まで設定できます。 + + **Warning**: 動画のエクスポート可能時間の消費時間が 72 時間を超えると課金が発生します。上限を変更しただけでは、課金は発生しません。動画のエクスポート可能時間の上限の設定にかかわらず、消費時間が 72 時間を超えると課金が発生します。料金について詳しくは、Soracom Cloud Camera Services ソラカメの [料金について](https://soracom.jp/sora_cam/#pricing) を参照してください。 + + **Warning**: 上限を 72 時間未満に設定することもできます。その場合でも、料金は変わりません。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: updateSoraCamDeviceExportUsageLimitOverride + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + limitHours: 144 + schema: + $ref: '#/components/schemas/SoraCamExportUsageLimitOverrideSpecification' required: true responses: "200": @@ -11090,7 +11685,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: listSoraCamDeviceImageExportsForDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11209,7 +11804,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: exportSoraCamDeviceRecordedImage parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11238,109 +11833,345 @@ paths: schema: $ref: '#/components/schemas/SoraCamImageExportInfo' description: OK. - "400": - description: '`time` に指定した値が不適切です。' + "400": + description: '`time` に指定した値が不適切です。' + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウドに保存された録画映像から静止画をエクスポートする処理を開始する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images export + /sora_cam/devices/{device_id}/images/exports/{export_id}: + get: + description: | + [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage) で開始した「録画映像から静止画をエクスポートする処理」の現在の状況をリストで取得します。この API では、対象を 1 つのエクスポート処理に限定します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: getSoraCamDeviceExportedImage + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + - description: 対象のエクスポート処理のエクスポート ID + in: path + name: export_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + (1) Initializing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: initializing + (2) Processing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: processing + (3) Completed: + value: + - deviceId: 7CDDDEADBEEF + expiryTime: 1662973800000 + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: completed + url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... + (4) Retrying: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: retrying + (5) Failed: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: failed + (6) limitExceeded: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: limitExceeded + (7) Expired: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: expired + schema: + items: + $ref: '#/components/schemas/SoraCamImageExportInfo' + type: array + description: OK. + "404": + description: 指定したソラカメ対応カメラ、またはエクスポート処理が見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウドに保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images get-exported + /sora_cam/devices/{device_id}/name: + get: + description: ソラカメ対応カメラの現在の名前を取得します。 + operationId: getSoraCamDeviceName + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの現在の名前を取得します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-name + post: + description: ソラカメ対応カメラの名前を変更します。 + operationId: setSoraCamDeviceName + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + responses: + "200": + description: OK. + "400": + description: 不正なパラメーターが指定されました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの名前を変更します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-name + /sora_cam/devices/{device_id}/power_state: + get: + description: ソラカメ対応カメラの電源状態を取得します。 + operationId: getSoraCamDevicePowerState + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの電源状態を取得します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-power-state + post: + description: ソラカメ対応カメラの電源状態を変更します。 + operationId: setSoraCamDevicePowerState + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + responses: + "200": + description: OK. + "400": + description: 不正なパラメーターが指定されました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの電源状態を変更します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-power-state + /sora_cam/devices/{device_id}/reboot: + post: + description: ソラカメ対応カメラを再起動します。 + operationId: rebootSoraCamDevice + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + description: OK. "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: クラウドに保存された録画映像から静止画をエクスポートする処理を開始する + summary: ソラカメ対応カメラを再起動します tags: - SoraCam x-soracom-cli: - - sora-cam devices images export - /sora_cam/devices/{device_id}/images/exports/{export_id}: + - sora-cam devices reboot + /sora_cam/devices/{device_id}/recordings_and_events: get: description: | - [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage) で開始した「録画映像から静止画をエクスポートする処理」の現在の状況をリストで取得します。この API では、対象を 1 つのエクスポート処理に限定します。 + ソラカメ対応カメラがクラウドに映像を録画した期間の一覧、およびソラカメ対応カメラが検知したイベントの一覧を取得します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: getSoraCamDeviceExportedImage + operationId: listSoraCamDeviceRecordingsAndEvents parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: ソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string - - description: 対象のエクスポート処理のエクスポート ID - in: path - name: export_id - required: true + - description: 前回の listSoraCamDeviceRecordingsAndEvents リクエストのレスポンスに含まれていた x-soracom-next-key + ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: リストの取得開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラに割り当てられたライセンスの保存期間のうち最も古い時刻が指定されます。 + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: リストの所得終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false schema: + format: int64 + type: integer + - description: | + 録画期間およびイベント一覧のソート順。 + + - `desc`: 降順 (最新のデータが先頭)。 + - `asc`: 昇順 (最も古いデータが先頭)。 + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc type: string responses: "200": content: application/json: - examples: - (1) Initializing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: initializing - (2) Processing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: processing - (3) Completed: - value: - - deviceId: 7CDDDEADBEEF - expiryTime: 1662973800000 - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: completed - url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... - (4) Retrying: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: retrying - (5) Failed: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: failed - (6) limitExceeded: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: limitExceeded - (7) Expired: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: expired + example: + events: + - endTime: 1699318810000 + startTime: 1699318800000 + type: motion + - endTime: 1699320820000 + startTime: 1699320810000 + type: sound + - endTime: 1699315210000 + startTime: 1699315200000 + type: motion + records: + - startTime: 1699318800000 + - endTime: 1699318800000 + startTime: 169931520000011 schema: - items: - $ref: '#/components/schemas/SoraCamImageExportInfo' - type: array + $ref: '#/components/schemas/SoraCamRecordingsAndEventsList' description: OK. + "400": + description: 不正なパラメーターが指定されました。 "404": - description: 指定したソラカメ対応カメラ、またはエクスポート処理が見つかりません。 + description: 指定されたソラカメ対応カメラ、または指定された期間の録画が見つかりませんでした。 security: - api_key: [] api_token: [] - summary: クラウドに保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する + summary: ソラカメ対応カメラが録画した期間の一覧およびイベントの一覧を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices images get-exported + - sora-cam devices recordings-and-events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sora_cam/devices/{device_id}/stream: get: description: | @@ -11353,14 +12184,12 @@ paths: - 最大 900 秒 (15 分) の録画映像をストリーミング再生できる URL を取得できます。 - URL を取得した時点で、視聴状況にかかわらず動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 - **Warning**: リアルタイム映像は、クラウドに保存された録画映像から最新の映像を取得する機能です。したがって、クラウド常時録画ライセンスもしくはクラウドモーション検知 “無制限” 録画ライセンスを割り当てていないソラカメ対応カメラのリアルタイム映像は取得できません。 - - **Warning**: ATOM アプリで再生できる「ライブ映像 (P2P)」は、リアルタイム映像とは異なる機能です。SORACOM API を利用して「ライブ映像 (P2P)」は取得できません。 + **Warning**: **リアルタイム映像**は、クラウドに保存された録画映像から最新の映像を取得する機能です。したがって、クラウド常時録画ライセンスもしくはクラウドモーション検知 “無制限” 録画ライセンスを割り当てていないソラカメ対応カメラのリアルタイム映像は取得できません。ATOM アプリで再生できる**「ライブ映像 (P2P)」**は、リアルタイム映像とは異なる機能です。SORACOM API を利用して「ライブ映像 (P2P)」は取得できません。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDeviceStreamingVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11421,7 +12250,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: listSoraCamDeviceVideoExportsForDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11541,7 +12370,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: exportSoraCamDeviceRecordedVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11592,7 +12421,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDeviceExportedVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -12045,7 +12874,7 @@ paths: 現在、この API は日本カバレッジでのみ利用可能です。 operationId: updateSoraCamLicensePackQuantity parameters: - - description: ライセンスパックの ID + - description: ライセンスパックの ID。 in: path name: license_pack_id required: true @@ -12056,7 +12885,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SoraCamLicensePackQuantityUpdatingRequest' - description: ライセンス数の更新内容 + description: ライセンス数の更新内容。 required: true responses: "204": @@ -12076,7 +12905,7 @@ paths: description: Soralet の一覧を取得します。 operationId: listSoralets parameters: - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12086,7 +12915,7 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false @@ -12148,7 +12977,7 @@ paths: description: Soralet を削除します。 operationId: deleteSoralet parameters: - - description: 削除したい Soralet の識別子 + - description: 削除したい Soralet の識別子。 in: path name: soralet_id required: true @@ -12171,7 +13000,7 @@ paths: description: Soralet を取得します。 operationId: getSoralet parameters: - - description: 取得したい Soralet の識別子 + - description: 取得したい Soralet の識別子。 in: path name: soralet_id required: true @@ -12199,13 +13028,13 @@ paths: description: 指定された Soralet からのログメッセージの一覧を取得します。 operationId: getSoraletLogs parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12215,7 +13044,7 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false @@ -12254,7 +13083,7 @@ paths: description: 引数を指定して Soralet をテスト実行します。 operationId: testSoralet parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true @@ -12265,7 +13094,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExecuteSoraletRequest' - description: 実行リクエスト + description: 実行リクエスト。 required: true responses: "200": @@ -12288,13 +13117,13 @@ paths: description: Soralet のバージョン一覧を取得します。 operationId: listSoraletVersions parameters: - - description: バージョン一覧を取得したい Soralet の識別子 + - description: バージョン一覧を取得したい Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12304,13 +13133,13 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false schema: type: integer - - description: 現在のページで最後に取得された Soralet の識別子を指定します。このパラメータを指定することで、Soralet のリストの続きを取得できます。 + - description: 現在のページで最後に取得されたバージョンの識別子を指定します。このパラメータを指定することで、バージョンのリストの続きを取得できます。 in: query name: last_evaluated_key required: false @@ -12342,7 +13171,7 @@ paths: description: コードをアップロードし、新しいバージョンを作成します。 operationId: uploadSoraletCode parameters: - - description: コードのアップロード先の Soralet の識別子 + - description: コードのアップロード先の Soralet の識別子。 in: path name: soralet_id required: true @@ -12360,7 +13189,7 @@ paths: schema: format: binary type: string - description: アップロードしたいファイルの内容 + description: アップロードしたいファイルの内容。 required: true responses: "201": @@ -12382,13 +13211,13 @@ paths: description: Soralet のバージョンを削除します。 operationId: deleteSoraletVersion parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: 削除したい Soralet のバージョン + - description: 削除したい Soralet のバージョン。 in: path name: version required: true @@ -12418,29 +13247,13 @@ paths: required: true schema: type: string - - description: | - 集計対象期間の開始月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 + - description: 対象期間の開始月/日を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: | - 集計対象期間の終了月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 + - description: 対象期間の終了月/日を UNIX 時間 (秒) で指定します。 in: query name: to required: true @@ -12449,8 +13262,22 @@ paths: - description: | 集計単位。 - - month: 月ごとに集計します。 - - day: 日ごとに集計します。 + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 7 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | in: query name: period required: true @@ -12489,29 +13316,13 @@ paths: required: true schema: type: string - - description: | - 集計対象期間の開始月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 + - description: 対象期間の開始月/日を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: | - 集計対象期間の終了月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 + - description: 対象期間の終了月/日を UNIX 時間 (秒) で指定します。 in: query name: to required: true @@ -12520,8 +13331,22 @@ paths: - description: | 集計単位。 - - month: 月ごとに集計します。 - - day: 日ごとに集計します。 + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 7 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | in: query name: period required: true @@ -12620,20 +13445,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で通信量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で通信量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12674,20 +13524,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で通信量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で通信量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12768,20 +13643,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12862,20 +13762,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12956,20 +13881,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -13007,7 +13957,7 @@ paths: required: true schema: type: string - - description: 年月を YYYYMM 形式で指定します。 + - description: 現在時刻の 18 か月前 〜 現在時刻の年月を YYYYMM 形式で指定します。 in: query name: year_month required: false @@ -13028,6 +13978,55 @@ paths: - Stats x-soracom-cli: - stats harvest operators get + /stats/harvest/operators/{operator_id}/export: + post: + description: | + オペレーターが所有していたすべての IoT SIM の SORACOM Harvest Data への書き込み回数を、[Harvest Data 書き込み回数実績データ CSV](/ja-jp/docs/harvest/stats-csv/) でダウンロードします。 + + **Info**: 解約した IoT SIM の SORACOM Harvest Data への書き込み回数も確認できます。 + operationId: exportHarvestStats + parameters: + - description: オペレーター ID。 + in: path + name: operator_id + required: true + schema: + type: string + - description: | + Harvest Data 書き込み回数実績データ CSV をダウンロードするための URL を取得する方法を指定します。 + + - `async`: SORACOM プラットフォームで URL が発行されるのを待たずに、`exportedFieldId` を取得します。この `exportedFieldId` を [`Files:getExportedFile API`](#/Files/getExportedFile) で指定すると、URL を取得できます。Harvest Data 書き込み回数実績データ CSV のファイルサイズが大きい場合は、`async` を利用してください。 + - `sync` (デフォルト): SORACOM プラットフォームで URL が発行されるのを待ちます。ただし、Harvest Data 書き込み回数実績データ CSV のファイルサイズが大きい場合など、タイムアウトして URL を取得できないことがあります。タイムアウトする場合は、`async` を指定してください。 + in: query + name: export_mode + required: false + schema: + enum: + - async + - sync + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportRequest' + description: 出力するデータの期間。 + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FileExportResponse' + description: OK. + security: + - api_key: [] + api_token: [] + summary: すべての IoT SIM の Harvest Data 書き込み回数をエクスポートする + tags: + - Stats + x-soracom-cli: + - stats harvest export /stats/harvest/subscribers/{imsi}: get: description: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得する。 @@ -13039,20 +14038,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -13084,7 +14108,7 @@ paths: description: 指定された年月における Napter 監査ログの読み込みデータ通信量を byte 単位で取得する。 operationId: getNapterAuditLogsExportedDataStats parameters: - - description: 年月を YYYYMM 形式で指定します。 + - description: 現在時刻の 18 か月前 〜 現在時刻の年月を YYYYMM 形式で指定します。 in: query name: year_month required: false @@ -13140,8 +14164,19 @@ paths: required: false schema: type: string - - description: '検索対象にする速度クラス。`|`で区切って複数指定することができる。指定可能な値の一覧は以下のとおり: `s1.minimum`, - `s1.slow`, `s1.standard`, `s1.fast`' + - description: | + 検索対象にする速度クラス。`|`で区切って複数指定することができる。指定可能な値の一覧は以下のとおり: + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` in: query name: speed_class_filter required: false @@ -13327,11 +14362,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | 前のページで取得した最後のデータエントリのキー。この API でのデータエントリーのキーは、`${UNIX 時間 (ミリ秒)}_${IMSI}` です。このパラメータを指定することで次のデータエントリを取得できます。 @@ -13759,7 +14796,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetImeiLockRequest' - description: Subscriber に指定する IMEI lock の設定 （オンラインの Subscriber の現在の IMEI にロックするには + description: Subscriber に指定する IMEI ロックの設定 （オンラインの Subscriber の現在の IMEI にロックするには IMEI は指定しなくてもよい） responses: "200": @@ -14530,7 +15567,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable: post: description: SIM ベースルーティングを無効化します。 - operationId: disableSimBasedRouging + operationId: disableSimBasedRouting parameters: - description: 対象の VPG の ID in: path @@ -14554,7 +15591,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable: post: description: SIM ベースルーティングを有効化します。 - operationId: enableSimBasedRouging + operationId: enableSimBasedRouting parameters: - description: 対象の VPG の ID in: path @@ -14924,7 +15961,7 @@ paths: - vpg unset-redirection /virtual_private_gateways/{vpg_id}/packet_capture_sessions: get: - description: 指定された VPG のパケットキャプチャセッションのリストを取得する。 + description: VPG に対するパケットキャプチャセッションのリストを取得する。 operationId: listPacketCaptureSessions parameters: - description: 対象の VPG ID @@ -14956,7 +15993,7 @@ paths: items: $ref: '#/components/schemas/PacketCaptureSession' type: array - description: 指定された VPG のパケットキャプチャセッションのリスト + description: VPG に対するパケットキャプチャセッションのリスト "400": description: Failed to list packet capture sessions associated with the VPG @@ -14965,7 +16002,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Packet Capture Sessions + summary: VPG に対するパケットキャプチャセッションのリストを取得する tags: - VirtualPrivateGateway x-soracom-cli: @@ -14976,7 +16013,7 @@ paths: response: header: x-soracom-next-key post: - description: 指定された VPG に対するパケットキャプチャセッションを作成する。 + description: VPG に対するパケットキャプチャセッションを作成する。 operationId: createPacketCaptureSession parameters: - description: 対象の VPG ID @@ -14998,22 +16035,22 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定された VPG に対するパケットキャプチャセッションの作成が成功した + description: VPG に対するパケットキャプチャセッション "400": - description: 指定された VPG に対するパケットキャプチャセッションの作成が失敗した + description: VPG に対するパケットキャプチャセッションの作成が失敗した "404": description: 指定された VPG が存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを作成する + summary: VPG に対するパケットキャプチャセッションを作成する tags: - VirtualPrivateGateway x-soracom-cli: - vpg create-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}: delete: - description: 指定した VPG 対するパケットキャプチャを削除する。 + description: VPG に対するパケットキャプチャセッションを削除する。 operationId: deletePacketCaptureSession parameters: - description: 対象の VPG ID @@ -15036,19 +16073,19 @@ paths: $ref: '#/components/schemas/PacketCaptureSession' description: 削除されたパケットキャプチャセッションの情報 "400": - description: 指定されたパケットキャプチャセッションの削除に失敗 + description: VPG に対するパケットキャプチャセッションの削除に失敗 "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを削除する + summary: VPG に対するパケットキャプチャセッションを削除する tags: - VirtualPrivateGateway x-soracom-cli: - vpg delete-packet-capture-session get: - description: 指定した VPG に対するパケットキャプチャを取得する。 + description: VPG に対するパケットキャプチャセッションを取得する。 operationId: getPacketCaptureSession parameters: - description: 対象の VPG ID @@ -15057,7 +16094,7 @@ paths: required: true schema: type: string - - description: パケットキャプチャセッション ID + - description: 対象のパケットキャプチャセッション ID in: path name: session_id required: true @@ -15069,20 +16106,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定されたパケットキャプチャセッション + description: VPG に対するパケットキャプチャセッション "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションの情報を取得する + summary: VPG に対するパケットキャプチャセッションを取得する tags: - VirtualPrivateGateway x-soracom-cli: - vpg get-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop: post: - description: 指定した SIM に対するパケットキャプチャを停止する。 + description: VPG に対するパケットキャプチャセッションを停止する。 operationId: stopPacketCaptureSession parameters: - description: 対象の VPG ID @@ -15108,13 +16145,13 @@ paths: description: The packet capture session can be stopped only when its status is CAPTURING "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない "500": - description: 指定されたパケットキャプチャセッションが停止できなかった + description: VPG に対するパケットキャプチャセッションが停止できなかった security: - api_key: [] api_token: [] - summary: Stop Packet Capture Session + summary: VPG に対するパケットキャプチャセッションを停止する tags: - VirtualPrivateGateway x-soracom-cli: @@ -15247,7 +16284,10 @@ paths: - vpg delete-vpc-peering-connection /volume_discounts: get: - description: 契約済みの長期利用割引リストを返します。 + description: | + 契約済みの長期利用割引リストを返します。 + + **Warning**: 取得できる情報は、過去 18 か月、または契約が終了してから 6 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listVolumeDiscounts responses: "200": @@ -15265,8 +16305,8 @@ paths: x-soracom-cli: - volume-discounts list post: - description: 新規で長期利用割引の見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。(現時点では、長期利用割引は - plan-D バンドルなし、plan-K でのみ利用できます。) + description: 新規で長期利用割引の見積もりの作成を行います。orderId を /volume_discounts/{order_id}/confirm + に PUT すると発注が完了します (現時点では、長期利用割引は plan-D バンドルなし、plan-K でのみ利用できます)。 operationId: createVolumeDiscountQuotation requestBody: content: @@ -15292,10 +16332,13 @@ paths: - volume-discounts create /volume_discounts/{contract_id}: get: - description: 契約済みの長期利用割引を返します。 + description: | + 契約済みの長期利用割引を取得します。 + + **Warning**: 取得できる情報は、過去 18 か月、または契約が終了してから 6 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getVolumeDiscount parameters: - - description: contract_id + - description: 契約 ID。 in: path name: contract_id required: true @@ -15504,7 +16547,7 @@ components: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true DeviceObjectModel: content: @@ -15535,7 +16578,7 @@ components: application/json: schema: $ref: '#/components/schemas/LagoonPlanChangingRequest' - description: req + description: リクエスト。 required: true MFAAuthenticationRequest: content: @@ -15610,19 +16653,19 @@ components: ActionConfigProperty: properties: accessKey: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string body: - description: ExecuteWebRequestAction の時のみ有効(任意) + description: ExecuteWebRequestAction のときのみ有効(任意)。 type: string contentType: - description: ExecuteWebRequestAction の時のみ有効 + description: ExecuteWebRequestAction のときのみ有効。 type: string endpoint: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string executionDateTimeConst: - description: executionDateTimeConst で指定したタイミングから指定分後に実行 + description: アクションを実行するタイミング。 enum: - IMMEDIATELY - BEGINNING_OF_NEXT_MONTH @@ -15631,16 +16674,16 @@ components: - NEVER type: string executionOffsetMinutes: - description: Run in the minutes after the timing of executionDateTimeConst + description: executionDateTimeConst で指定したタイミングから指定分後に実行。 type: string functionName: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string headers: - description: ExecuteWebRequestAction の時のみ有効(任意) + description: ExecuteWebRequestAction のときのみ有効(任意)。 type: object httpMethod: - description: ExecuteWebRequestAction の時のみ有効 + description: ExecuteWebRequestAction のときのみ有効。 enum: - GET - POST @@ -15648,43 +16691,46 @@ components: - DELETE type: string message: - description: SendMailAction, SendMailToOperatorAction の時のみ有効 + description: SendMailAction、SendMailToOperatorAction のときのみ有効。 type: string parameter1: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter2: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter3: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter4: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter5: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string secretAccessKey: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string speedClass: - description: ChangeSpeedClassAction の時のみ有効 + description: ChangeSpeedClassAction のときのみ有効。 enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string title: - description: SendMailAction, SendMailToOperatorAction の時のみ有効 + description: SendMailAction、SendMailToOperatorAction のときのみ有効。 type: string to: - description: SendMailAction の時のみ有効 + description: SendMailAction のときのみ有効。 type: string url: - description: 接続先 URL とパラメータ ExecuteWebRequestAction の時のみ有効 + description: 接続先 URL とパラメータ。ExecuteWebRequestAction のときのみ有効。 type: string required: - executionDateTimeConst @@ -16057,15 +17103,15 @@ components: description: リクエストとそれに対する結果を結びつけるための識別子。 type: string lat: - description: 推定座標の緯度 + description: 推定座標の緯度。 format: double type: number lon: - description: 推定座標の経度 + description: 推定座標の経度。 format: double type: number range: - description: 基地局のエリアの範囲（推定座標からの半径。メートル単位）。測定値から推定された値の場合と、信頼できる情報源から得た値の場合がある。 + description: 基地局のエリアの範囲 (推定座標からの半径。メートル単位)。測定値から推定された値の場合と、信頼できる情報源から得た値の場合がある。 format: int32 type: integer samples: @@ -16272,6 +17318,8 @@ components: type: object CreateGroupRequest: properties: + configuration: + $ref: '#/components/schemas/GroupConfiguration' tags: $ref: '#/components/schemas/TagSet' type: object @@ -16280,7 +17328,7 @@ components: description: type: string permission: - description: Permission の JSON + description: パーミッションの JSON。 type: string required: - permission @@ -16290,12 +17338,12 @@ components: destination: $ref: '#/components/schemas/PortMappingDestination' duration: - description: リモートアクセスを有効にする時間 (秒単位) + description: リモートアクセスを有効にする時間 (秒単位)。 type: number source: $ref: '#/components/schemas/PortMappingSource' tlsRequired: - description: リモートアクセスに TLS を使用するかどうか + description: リモートアクセスに TLS を使用するかどうか。 type: boolean required: - destination @@ -16388,14 +17436,39 @@ components: type: integer type: enum: + - api-token-credentials - aws-credentials + - aws-iam-role-credentials - azure-credentials + - azureIoT-credentials + - esrij-credentials + - google-service-account-json + - googleIoT-credentials + - infoteria-platio-credentials + - kii-thingif-credentials + - landlog-credentials + - mmcloud-credentials + - mockmock-datarecorder-credentials + - motionboard-credentials + - optim-cloud-IoT-OS-credentials + - private-key-pem - psk + - pubnub-credentials + - sensorcorpus-credentials + - username-password-credentials + - watsonIoT-credentials - x509 type: string updateDateTime: format: int64 type: integer + required: + - createDateTime + - credentials + - credentialsId + - lastUsedDateTime + - type + - updateDateTime type: object CreditCard: properties: @@ -16543,12 +17616,12 @@ components: DiagnosticRequest: properties: from: - description: 診断対象期間の始まり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の始まり (UNIX 時間 (ミリ秒))。 format: int64 type: integer resourceId: description: | - resourceType に応じた識別子 + resourceType に応じた識別子。 - resourceType が `sim` の場合は、SIM ID を指定します。 type: string @@ -16561,7 +17634,7 @@ components: - Air type: string to: - description: 診断対象期間の終わり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の終わり (UNIX 時間 (ミリ秒))。 format: int64 type: integer required: @@ -16574,7 +17647,7 @@ components: diagnosticId: type: string from: - description: 診断対象期間の始まり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の始まり (UNIX 時間 (ミリ秒))。 format: int64 type: integer insights: @@ -16584,7 +17657,7 @@ components: type: object type: array resourceId: - description: resourceType に応じた識別子 + description: resourceType に応じた識別子。 type: string resourceType: enum: @@ -16601,7 +17674,7 @@ components: - failed type: string to: - description: 診断対象期間の終わり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の終わり (UNIX 時間 (ミリ秒))。 format: int64 type: integer type: object @@ -16633,13 +17706,21 @@ components: EmailConfigurationOfBilling: properties: attachInvoicePdfEnabled: - description: true の場合、毎月の請求メールに請求書 PDF を添付します（グローバルカバレッジのみ）。 + description: | + 毎月の請求に関するお知らせメールにソラコム発行の請求書 (PDF) を添付するかどうかの設定 (グローバルカバレッジのみ)。 + + - `true`: 添付します。 + - `false`: 添付しません。 type: boolean type: object EmailConfigurationOfNotification: properties: exceedBundleDisabled: - description: true の場合、通信量がバンドルの容量に近づいた時に送付する通知メールを全て無効にします。 + description: | + データ通信量に関するプライマリメールアドレスへの通知設定。詳しくは、[データ通信量に関する通知を停止する](/ja-jp/docs/air/set-bundle/#データ通信量に関する通知を停止する) を参照してください。 + + - `true`: データ通信量に関するプライマリメールアドレスへの通知をすべて停止します。 + - `false`: データ通信量に関するプライマリメールアドレスへの通知をすべて有効化します。 type: boolean type: object EmailsModel: @@ -16655,13 +17736,15 @@ components: format: int64 type: integer verified: - description: メールアドレス宛てに送信されたトークンを用いて認証済みかどうか + description: メールアドレス宛てに送信されたトークンを用いて認証済みかどうか。 type: boolean type: object EnableMFAOTPResponse: properties: totpUri: type: string + required: + - totpUri type: object Error: properties: @@ -16706,7 +17789,6 @@ components: properties: product: $ref: '#/components/schemas/ProductModel' - description: 商品 productAmount: description: 商品金額 format: double @@ -16764,7 +17846,6 @@ components: type: string shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' - description: 発送先 shippingAddressId: description: 商品発送先 ID type: string @@ -16814,7 +17895,6 @@ components: type: number volumeDiscount: $ref: '#/components/schemas/VolumeDiscountModel' - description: 長期利用割引 type: object EventHandlerModel: properties: @@ -16925,24 +18005,45 @@ components: ExportRequest: properties: from: - description: 対象期間の開始日時 (UNIX 時間 (秒)) + description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 example: 1654009200 format: int64 type: integer period: description: | - 履歴の詳細度。 + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 - - `month`: 月ごと - - `day`: 日ごと - - `minutes`: 分ごと + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です 。| + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | enum: - month - day - minutes type: string to: - description: 対象期間の終了日時 (UNIX 時間 (秒)) + description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 example: 1656601200 format: int64 type: integer @@ -17349,15 +18450,15 @@ components: attributes: properties: contractEndingTime: - description: SORACOM LTE-M Button powered by AWS の有効期限 + description: SORACOM LTE-M Button powered by AWS の有効期限。 format: date-time type: string firstClickTimestamp: - description: SORACOM LTE-M Button powered by AWS を初めてクリックした日時 + description: SORACOM LTE-M Button powered by AWS を初めてクリックした日時。 format: date-time type: string remainingCount: - description: SORACOM LTE-M Button powered by AWS の残りクリック回数 + description: SORACOM LTE-M Button powered by AWS の残りクリック回数。 type: integer wimaxBillingStartDate: description: ソラカメ専用セルラーパックの課金開始日。 @@ -17372,25 +18473,25 @@ components: type: string type: object createdTime: - description: Gadget API 対応デバイスを登録した UNIX 時間 (ミリ秒) + description: Gadget API 対応デバイスを登録した UNIX 時間 (ミリ秒)。 format: int64 type: integer id: - description: Gadget API 対応デバイスの ID + description: Gadget API 対応デバイスの ID。 type: string lastModifiedTime: - description: Gadget API 対応デバイスの情報が変更された UNIX 時間 (ミリ秒) + description: Gadget API 対応デバイスの情報が変更された UNIX 時間 (ミリ秒)。 format: int64 type: integer lastSeen: properties: batteryLevel: - description: SORACOM LTE-M Button powered by AWS のバッテリーレベル + description: SORACOM LTE-M Button powered by AWS のバッテリーレベル。 type: integer clickEventPropagated: type: boolean clickTime: - description: SORACOM LTE-M Button powered by AWS をクリックした日時 + description: SORACOM LTE-M Button powered by AWS をクリックした日時。 format: date-time type: string clickType: @@ -17400,27 +18501,27 @@ components: type: string type: object operatorId: - description: Gadget API 対応デバイスを登録したオペレーター ID + description: Gadget API 対応デバイスを登録したオペレーター ID。 type: string productId: description: | - Gadget API 対応デバイスのタイプ + Gadget API 対応デバイスのタイプ。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 enum: - button - wimax type: string serialNumber: - description: Gadget API 対応デバイスのシリアル番号 + description: Gadget API 対応デバイスのシリアル番号。 type: string status: description: | - Gadget API 対応デバイスの契約状態 + Gadget API 対応デバイスの契約状態。 - - `active`: 契約中 - - `terminated`: 解約済み + - `active`: 契約中。 + - `terminated`: 解約済み。 enum: - active - terminated @@ -17437,10 +18538,10 @@ components: terminationEnabled: default: false description: | - Gadget API 対応デバイスの解約プロテクション + Gadget API 対応デバイスの解約プロテクション。 - - `true`: OFF (解約できる) - - `false`: ON (解約できない) + - `true`: OFF (解約できる)。 + - `false`: ON (解約できない)。 type: boolean type: object GadgetRegistrationRequest: @@ -17448,7 +18549,7 @@ components: tags: additionalProperties: type: string - description: タグ + description: タグ。 type: object type: object GatePeer: @@ -17474,9 +18575,9 @@ components: tokenTimeoutSeconds: default: 86400 description: | - 新しい API トークンの有効期限の長さ（秒単位）。 - 指定しなければデフォルトは 86400 [秒]（24 時間）。 - 最大値は 172800 [秒]（48 時間）。 + 新しい API トークンの有効期限の長さ (秒単位)。 + 指定しなければデフォルトは 86400 [秒] (24 時間)。 + 最大値は 172800 [秒] (48 時間)。 maximum: 172800 type: integer type: object @@ -17563,43 +18664,43 @@ components: GetOrderResponse: properties: appliedShippingOptions: - description: 適用済み配送オプション + description: 適用済み配送オプション。 items: type: object type: array balanceDue: - description: 差引請求額 + description: 差引請求額。 format: double type: number containsTaxIncludedAmounts: type: boolean currency: - description: 通貨 + description: 通貨。 enum: - JPY - USD - EUR type: string email: - description: メールアドレス + description: メールアドレス。 type: string orderChannel: - description: 発注チャンネル + description: 発注チャンネル。 type: string orderDateTime: - description: 発注日時 (yyyyMMddHHmmss) + description: 発注日時 (yyyyMMddHHmmss)。 format: yyyyMMddHHmmss type: string orderId: - description: 発注 ID + description: 発注 ID。 type: string orderItemList: - description: 発注商品リスト + description: 発注商品リスト。 items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array orderStatus: - description: 発注ステータス + description: 発注ステータス。 enum: - ordering - ordered @@ -17610,49 +18711,93 @@ components: - cancelled - failed type: string + paymentStatus: + description: | + お支払い状況。詳しくは、FAQ: [ご利用料金のお支払状況について](https://support.soracom.io/hc/ja/articles/360029337031) を参照してください。 + + - `lessThanMinimumCharge`: 翌月以降請求 (最低課金額に満たないため)。 + - `paying`: 支払い処理中。 + - `paid`: 支払い済み。 + - `fail`: 処理失敗。 + - `refunding`: リファンド処理中。 + - `refunded`: リファンド済み。 + - `refund_fail`: リファンド処理失敗。 + - `delegating_to_third_party`: 債権譲渡中。 + - `delegated_to_third_party`: 債権譲渡済み。 + - `charging`: 請求実施中。 + - `canceling`: キャンセル中。 + - `cancelled`: キャンセル済み。 + - `cancel_failed`: キャンセル処理失敗。 + enum: + - lessThanMinimumCharge + - paying + - paid + - fail + - refunding + - refunded + - refund_fail + - delegating_to_third_party + - delegated_to_third_party + - charging + - canceling + - cancelled + - cancel_failed + type: string preferredDeliveryDate: - description: 希望納品日 + description: 希望納品日。 type: string purchaseOrderNumber: - description: 注文番号 + description: 注文番号。 type: string resourceInitialSetting: $ref: '#/components/schemas/ResourceInitialSetting' shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' - description: 発送先 shippingAddressId: - description: 商品発送先 ID + description: 商品発送先 ID。 type: string shippingCost: - description: 配送料 + description: 配送料。 format: double type: number + shippingDateTime: + description: 発送日時 (yyyyMMddHHmmss)。 + example: 20231004123456 + format: yyyyMMddHHmmss + type: string + shippingLabelDetails: + description: 配送業者の追跡情報。 + items: + $ref: '#/components/schemas/ShippingLabelDetail' + type: array shippingLabelNumber: - description: 宅配便送り状番号 (代表) + description: 配送業者の伝票番号 (代表)。 + example: 0000-1111-2222 type: string shippingLabelNumbers: - description: 宅配便送り状番号 + description: 配送業者の伝票番号。 + example: + - 0000-1111-2222 items: type: string type: array taxAmount: - description: 税額 + description: 税額。 format: double type: number taxIncludedInShippingCost: - description: 送料に含まれる税額 + description: 送料に含まれる税額。 format: double type: number taxOnShippingCost: - description: 配送料の課税有無 + description: 配送料の課税有無。 type: boolean totalAmount: - description: 合計額 (税込) + description: 合計額 (税込)。 format: double type: number withholdingTaxAmount: - description: 源泉徴収税額 + description: 源泉徴収税額。 format: double type: number type: object @@ -17749,10 +18894,10 @@ components: phoneNumber: type: string shippingAddressId: - description: 配送先 ID + description: 配送先 ID。 type: string shippingArea: - description: 配送先エリア + description: 配送先エリア。 type: string state: type: string @@ -17784,10 +18929,12 @@ components: properties: trustPolicy: description: | - 信頼ポリシー (JSON)。以下の情報が含まれます。詳しくは、[信頼ポリシー構文](/ja-jp/docs/switch-user/trust-policy/) を参照してください。 + この SAM ユーザーにスイッチできるルートユーザーまたは SAM ユーザーを指定する信頼ポリシー。以下の情報が含まれます。 - - `operator_id` と `user_name` で指定した SAM ユーザーにスイッチできるユーザーを表す SRN (Soracom Resource Name)。 + - この SAM ユーザーにスイッチできる別のアカウントのユーザーを表す SRN (Soracom Resource Name)。 - スイッチできる条件。 + + 詳しくは、[信頼ポリシー構文](/ja-jp/docs/switch-user/trust-policy/) を参照してください。 type: string type: object GetVolumeDiscountResponse: @@ -17805,7 +18952,7 @@ components: format: int32 type: integer currency: - description: Currency + description: 通貨 enum: - JPY - USD @@ -17854,7 +19001,7 @@ components: Group: properties: configuration: - $ref: '#/components/schemas/Map' + $ref: '#/components/schemas/GroupConfiguration' createdTime: format: int64 type: integer @@ -17868,6 +19015,27 @@ components: tags: $ref: '#/components/schemas/TagSet' type: object + GroupConfiguration: + additionalProperties: + description: | + キーは、以下のいずれかのネームスペースです。 + + - SoracomAir + - SoracomBeam + - SoracomEndorse + - SoracomOrbit + - SoracomFunk + - SoracomFunnel + - SoracomHarvest + - SoracomHarvestFiles + - SoracomKrypton + - UnifiedEndpoint + + 値は、ネームスペースごとに異なるオブジェクトです。 + type: object + description: | + グループの設定。 + type: object GroupConfigurationUpdateRequest: properties: key: @@ -17933,8 +19101,8 @@ components: Insight: properties: anomalyDetectedTimes: - description: 異常と思われる状況を検出した時間。フォーマットは category に関するイベントのタイムスタンプに依存します。（例：session - の場合は UNIX 時間 (ミリ秒)） + description: 異常と思われる状況を検出した時間。フォーマットは category に関するイベントのタイムスタンプに依存します。(例：session + の場合は UNIX 時間 (ミリ秒)) items: type: string type: array @@ -17951,7 +19119,7 @@ components: message: type: string referenceUrls: - description: インサイトに関連のある参考情報の URL + description: インサイトに関連のある参考情報の URL。 items: additionalProperties: $ref: '#/components/schemas/ReferenceUrl' @@ -17983,10 +19151,10 @@ components: IssueAddEmailTokenRequest: properties: email: - description: 追加するメールアドレス + description: 追加するメールアドレス。 type: string password: - description: ルートユーザーのパスワード + description: ルートユーザーのパスワード。 type: string required: - email @@ -18125,8 +19293,8 @@ components: licensePackName: description: | 個数を変更するライセンスパックを指定します。 - - `basicUser`: ユーザー追加パック - - `basicDashboard`: ダッシュボード追加パック + - `basicUser`: ユーザー追加パック。 + - `basicDashboard`: ダッシュボード追加パック。 enum: - basicUser - basicDashboard @@ -18137,7 +19305,7 @@ components: LagoonMigrationRequest: properties: dashboardIds: - description: A list of dashboard IDs to migrate + description: バージョン移行する Dashboard の ID のリスト。 items: type: string type: array @@ -18160,30 +19328,30 @@ components: - pro type: string userPassword: - description: This password is used by the initial user's login. + description: はじめに作成される Lagoon ユーザーのパスワード。 type: string type: object LagoonRegistrationResponse: properties: lagoonUserEmail: - description: This email address is used on login with the initial user. + description: はじめに作成される Lagoon ユーザーのメールアドレス。 type: string type: object LagoonUser: properties: email: - description: This value used on login. + description: Lagoon ユーザーのメールアドレス。 type: string id: type: number lastSeenAt: - description: The last login datetime. + description: 最終ログイン日時。 type: string lastSeenAtAge: - description: The last login datetime as age. + description: 最終ログインからの経過日数。 type: string role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18192,7 +19360,7 @@ components: LagoonUserCreationRequest: properties: role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18205,7 +19373,7 @@ components: LagoonUserCreationResponse: properties: id: - description: Lagoon user ID assigned to the created user. + description: Lagoon ユーザーの ID。 type: integer type: object LagoonUserEmailUpdatingRequest: @@ -18223,7 +19391,7 @@ components: LagoonUserPermissionUpdatingRequest: properties: role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18471,7 +19639,7 @@ components: MFARevokeRequest: properties: password: - description: ルートユーザーのパスワード + description: ルートユーザーのパスワード。 type: string required: - password @@ -18642,6 +19810,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfEmail' - $ref: '#/components/schemas/OperatorConfigurationOfSupport' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' isModifiable: description: false の場合、コンフィグレーションを setOperatorConfigurationNamespace API で更新できません。 @@ -18653,7 +19822,7 @@ components: - Email type: string version: - description: コンフィグレーションのバージョン + description: コンフィグレーションのバージョン。 type: number type: object OperatorConfigurationOfEmail: @@ -18678,6 +19847,15 @@ components: - $ref: '#/components/schemas/SupportTier' description: 来月に適用される予定のサポートプランです。この値が無い場合は、翌月も現在のサポートプランが継続されます。 type: object + OperatorConfigurationOfUserConsole: + properties: + usageMetricsAcknowledged: + description: オペレーターが使用状況メトリクスを収集することを認識し、オプトアウトする機会が与えられたことを示します。使用状況メトリクスには、ページビューやパフォーマンス統計などの情報が含まれます。 + type: boolean + usageMetricsDisabled: + description: ユーザーコンソールの使用状況メトリクスの収集を無効にするかどうかの設定です。使用状況メトリクスには、ページビューやパフォーマンス統計などの情報が含まれます。 + type: boolean + type: object OperatorMFAVerifyingResponse: properties: backupCodes: @@ -18825,7 +20003,7 @@ components: format: double type: number chargedYearMonths: - description: この請求に含まれる利用年月のリスト。請求内容が月額費用でない場合は、このフィールドは省略されます。 月額利用料金が一定金額未満の場合は翌月に繰り越されることがあり、そのようなケースでは複数月含まれることがあります。 + description: この請求に含まれる利用年月のリスト。請求内容が月額費用でない場合は、このフィールドは省略されます。月額利用料金が一定金額未満の場合は翌月に繰り越されることがあり、そのようなケースでは複数月含まれることがあります。 items: type: string type: array @@ -18863,14 +20041,13 @@ components: - aws type: string region: - default: eu-central-1 description: | `infrastructureProvider` が `aws` の場合は、ランデブーポイントです。 - - `ap-northeast-1`: 東京 (日本) - - `eu-central-1`: フランクフルト (ドイツ) - - `us-west-2`: オレゴン (米国) - - `ap-southeast-2`: シドニー (オーストラリア) + - `ap-northeast-1`: 東京 (日本)。日本カバレッジのデフォルトです。 + - `eu-central-1`: フランクフルト (ドイツ)。グローバルカバレッジのデフォルトです。 + - `us-west-2`: オレゴン (米国)。 + - `ap-southeast-2`: シドニー (オーストラリア)。 enum: - ap-northeast-1 - eu-central-1 @@ -18883,34 +20060,50 @@ components: destination: $ref: '#/components/schemas/PortMappingDestination' duration: - description: リモートアクセスが有効になっている期間 (秒) + description: リモートアクセスが有効になっている期間 (秒)。 type: number endpoint: - description: オンデマンドリモートアクセス (IP アドレスとポート番号) + description: オンデマンドリモートアクセス (IP アドレスとポート番号)。 type: string hostname: - description: オンデマンドリモートアクセスのホスト名 + description: オンデマンドリモートアクセスのホスト名。 type: string ipAddress: - description: オンデマンドリモートアクセスの IP アドレス + description: オンデマンドリモートアクセスの IP アドレス。 type: string port: - description: オンデマンドリモートアクセスの ポート番号 + description: オンデマンドリモートアクセスの ポート番号。 type: number source: $ref: '#/components/schemas/PortMappingSource' tlsRequired: - description: TLS の有効/無効 + description: TLS の有効/無効。 type: boolean type: object PortMappingDestination: properties: imsi: - description: 対象となる IMSI + description: 対象となる IMSI。 `simId` パラメーターが指定されている場合、このパラメーターは無視されます。 type: string port: - description: デバイスが SSH 接続を待ち受けているポート番号 + description: デバイスが SSH 接続を待ち受けているポート番号。 type: number + service: + description: | + オンデマンドリモートアクセスを作成する対象を決定するためのパラメーター。`simId` パラメーターが指定されている時に有効になります。 + + - `air`: セッションがオンラインの SORACOM Air のサブスクライバー。 + - `arc`: SORACOM Arc のバーチャル SIM/Subscriber。 + + **Warning**: 何も指定しなかった場合は、セッションがオンラインのサブスクライバーが、オンデマンドリモートアクセスを作成する対象となります。セッションがオンラインのサブスクライバーが複数ある場合、つまり SORACOM Air のセッションと SORACOM Arc のセッションが両方オンラインの場合は、どちらがオンデマンドリモートアクセス作成の対象となるかは保証されません。`air` または `arc` を指定することを推奨します。 + enum: + - air + - arc + type: string + simId: + description: 対象となる SIM ID。このパラメータは `imsi` パラメーターよりも優先されます。このパラメータが指定されている場合、`service` + で指定されたパラメーターに応じてオンデマンドリモートアクセスが作成されます。 + type: string required: - imsi - port @@ -18918,7 +20111,7 @@ components: PortMappingSource: properties: ipRanges: - description: オンデマンドリモートアクセスへのアクセスを許可する CIDR 表記の IP アドレスの範囲 + description: オンデマンドリモートアクセスへのアクセスを許可する CIDR 表記の IP アドレスの範囲。 items: type: string type: array @@ -19092,18 +20285,6 @@ components: type: string type: object type: object - RegisterOperatorsRequest: - properties: - email: - type: string - password: - description: パスワードは以下の条件を満たしている必要があります：長さ 8 文字以上 100 文字以内、アルファベット小文字 (a-z) - を 1 文字以上使用、アルファベット大文字 (A-Z) を 1 文字以上使用、数字を 1 文字以上使用。記号なども使用できます。 - type: string - required: - - email - - password - type: object RegisterPayerInformationModel: properties: companyName: @@ -19146,7 +20327,20 @@ components: simInitialSettings: additionalProperties: $ref: '#/components/schemas/SimInitialSetting' - description: SIM のサブスクリプションごとの初期設定です。キーにサブスクリプションを表す文字列を指定します。 + description: | + IoT SIM のサブスクリプションごとの初期設定です。キーにサブスクリプションを表す文字列を指定します。 + + - `plan01s` + - `plan01s-low_data_volume` (plan01s - Low Data Volume) + - `planX3` (planX3 X3-5MB) + - `planP1` + - `plan-D` (plan-D (バンドルなし)、plan-D D-300MB) + - `plan-K2` (plan-K2 K2-300MB) + - `plan-DU` + - `plan-KM1` + - `plan-K` + - `plan-US` + - `plan-NA1-package` (plan-NA1) example: plan01s: groupId: 00000000-1111-2222-3333-444444444444 @@ -19207,33 +20401,33 @@ components: ResourceSummary: properties: resourceSummaryItems: - description: リソースの要約アイテムの一覧 + description: リソースの要約アイテムの一覧。 items: $ref: '#/components/schemas/ResourceSummaryItem' type: array resourceSummaryType: description: | - リソースの要約の種別 + リソースの要約の種別。 - - `simsPerStatus`: ステータスごとの IoT SIM の数 + - `simsPerStatus`: ステータスごとの IoT SIM の数。 example: simsPerStatus type: string type: object ResourceSummaryItem: properties: dimensions: - description: リソースの要約アイテムのディメンションの一覧 + description: リソースの要約アイテムのディメンションの一覧。 example: [] items: $ref: '#/components/schemas/ResourceSummaryItemDimension' type: array updatedTime: - description: リソースの要約アイテムの最終更新日時 (unixtime ミリ秒単位) + description: リソースの要約アイテムの最終更新日時 (UNIX 時間 (ミリ秒))。 example: 1654007722000 format: int64 type: integer values: - description: リソースの要約アイテムの集計値の一覧 + description: リソースの要約アイテムの集計値の一覧。 items: $ref: '#/components/schemas/ResourceSummaryItemValue' type: array @@ -19241,28 +20435,28 @@ components: ResourceSummaryItemDimension: properties: name: - description: リソースの要約アイテムのディメンションの名前 + description: リソースの要約アイテムのディメンションの名前。 type: string value: - description: リソースの要約アイテムのディメンションの値 + description: リソースの要約アイテムのディメンションの値。 type: string type: object ResourceSummaryItemValue: properties: name: description: | - リソースの要約アイテムの集計値の名前 + リソースの要約アイテムの集計値の名前。 - `resourceSummaryType` が `simsPerStatus` の場合: - - `readySims`: ステータスが「準備完了 (ready)」の IoT SIM の数 - - `activeSims`: ステータスが「使用中 (active)」の IoT SIM の数 - - `inactiveSims`: ステータスが「休止中 (inactive)」の IoT SIM の数 - - `standbySims`: ステータスが「利用開始待ち (standby)」の IoT SIM の数 - - `suspendedSims`: ステータスが「利用中断中 (suspended)」の IoT SIM の数 + - `readySims`: ステータスが「準備完了 (ready)」の IoT SIM の数。 + - `activeSims`: ステータスが「使用中 (active)」の IoT SIM の数。 + - `inactiveSims`: ステータスが「休止中 (inactive)」の IoT SIM の数。 + - `standbySims`: ステータスが「利用開始待ち (standby)」の IoT SIM の数。 + - `suspendedSims`: ステータスが「利用中断中 (suspended)」の IoT SIM の数。 example: activeSims type: string value: - description: リソースの要約アイテムの集計値の値 + description: リソースの要約アイテムの集計値の値。 example: 1 type: number type: object @@ -19274,7 +20468,7 @@ components: description: type: string permission: - description: Permission の JSON + description: パーミッションの JSON。 type: string roleId: type: string @@ -19350,23 +20544,27 @@ components: - false type: string targetOtaStatus: - description: SimSubscriptionStatusRule の時のみ有効 + description: SimSubscriptionStatusRule のときのみ有効。 enum: - started - finished - failed type: string targetSpeedClass: - description: SubscriberSpeedClassAttributeRule の時のみ有効 + description: SubscriberSpeedClassAttributeRule、SimSpeedClassAttributeRule + のときのみ有効。 enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string targetStatus: - description: SubscriberStatusAttributeRule の時のみ有効 + description: SubscriberStatusAttributeRule、SimStatusAttributeRule のときのみ有効。 enum: - ready - active @@ -19488,6 +20686,10 @@ components: SetImeiLockRequest: properties: imei: + description: | + 対象デバイスの IMEI。一時的に IMEI が報告されない場合でもセッションの確立を許可する場合は、`|ANONYMOUS` を追記します。 + + たとえば、対象デバイスの IMEI が `123456789012345` の場合に `123456789012345|ANONYMOUS` を指定すると、一時的に IMEI が報告されない場合でもセッションの確立を許可します。 type: string type: object SetNetworkSetRequest: @@ -19501,6 +20703,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfSupport' - $ref: '#/components/schemas/OperatorConfigurationOfEmail' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' expectedVersion: description: このプロパティは、更新時のコンフリクトを避けるために利用します。利用する場合、getOperatorConfigurationNamespace API で 取得した version の値をここに指定します。 もし expectedVersion を指定しなかった場合は、更新時にコンフリクトの確認をしません。 @@ -19538,7 +20741,7 @@ components: type: string type: object ShippingAddressModel: - description: お届け先 + description: 商品発送先。 properties: addressLine1: type: string @@ -19613,6 +20816,28 @@ components: format: int32 type: integer type: object + ShippingLabelDetail: + properties: + shipmentCompany: + description: 配送業者名。 + example: Yamato Transport + type: string + shipmentCompanyUrl: + description: 配送業者 URL。 + example: http://track.kuronekoyamato.co.jp/english/tracking + type: string + trackingNumber: + description: 荷物の伝票番号。 + example: 0000-1111-2222 + type: string + trackingUrl: + description: 伝票番号付きの配送状況確認 URL。 + example: https://jizen.kuronekoyamato.co.jp/jizen/servlet/crjz.b.NQ0010?id=0000-1111-2222 + type: string + required: + - shipmentCompany + - trackingNumber + type: object ShippingOptionOfExpeditedShipping: description: 米国およびカナダのオペレーターのみご利用いただけます。 properties: @@ -19627,7 +20852,7 @@ components: description: ネコポスの使用を許可する場合は true を指定します。 type: boolean shipmentCompany: - description: 運送会社 + description: 配送業者。 enum: - yamato_transport type: string @@ -19831,9 +21056,27 @@ components: description: グループ ID。 type: string speedClass: - description: |- - 速度クラス。 - - サブスクリプションにあわせた速度クラスを指定してください。 + description: | + 速度クラス。以下のいずれかを指定します。ただし、サブスクリプションにあわせた速度クラスを指定してください。 + + - plan01s、plan01s - Low Data Volume、planX3 X3-5MB、planP1、plan-D (バンドルなし)、plan-D D-300MB、plan-K2 K2-300MB、plan-K の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - plan-US の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - plan-DU の場合: + - `u1.standard` + - `u1.slow` + - plan-KM1 の場合: + - `t1.standard` type: string tags: additionalProperties: @@ -19862,6 +21105,31 @@ components: $ref: '#/components/schemas/SimplifiedSubscriber' type: object type: object + SimStatusHistoryResponse: + properties: + applyDateTimeEpochSec: + type: integer + bundles: + items: + type: string + type: array + groupId: + type: string + imsi: + type: string + isPrimary: + type: boolean + primaryImsi: + type: string + simId: + type: string + speedClass: + type: string + status: + type: string + subscription: + type: string + type: object SimplifiedSubscriber: properties: bundles: @@ -19902,6 +21170,178 @@ components: payload: type: string type: object + SoraCamAtomCamSettings: + properties: + logo: + description: | + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + motionTagging: + description: | + モーションタグの表示設定。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + nightVision: + description: | + ナイトビションモードの設定。 + + - `on`: ナイトビジョンモード。 + - `off`: 通常モード。 + - `auto`: 自動切り替え。 + enum: + - "on" + - "off" + - auto + type: string + quality: + description: | + ライブ動画やクラウド録画の画質設定。なお、クラウド録画の場合は画質設定に関わらず、解像度は 1080p (1920 x 1080 ピクセル) です。 + + - `low`: ATOM アプリで「360p」を選択したときと同じ画質。 + - `medium`: ATOM アプリで「SD」を選択したときと同じ画質。 + - `high`: ATOM アプリで「HD (1080p)」を選択したときと同じ画質。 + enum: + - low + - medium + - high + type: string + rotation: + description: | + 画像を 180° 回転させる設定。ソラカメ対応カメラを上下反対に設置した場合に `180` を設定します。 + + - `0`: OFF (回転なし)。 + - `180`: ON (180° 回転)。 + enum: + - 0 + - 180 + type: integer + statusLight: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定。 + + - `on`: 点灯。 + - `off`: 消灯。 + enum: + - "on" + - "off" + type: string + timestamp: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsLogo: + properties: + state: + description: | + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsMotionTagging: + properties: + state: + description: | + モーションタグの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsNightVision: + properties: + state: + description: | + ナイトビションモードの設定。 + + - `on`: ナイトビジョンモード。 + - `off`: 通常モード。 + - `auto`: 自動切り替え。 + enum: + - "on" + - "off" + - auto + type: string + type: object + SoraCamAtomCamSettingsQuality: + properties: + state: + description: | + ライブ動画やクラウド録画の画質設定。なお、クラウド録画の場合は画質設定に関わらず、解像度は 1080p (1920 x 1080 ピクセル) です。 + + - `low`: ATOM アプリで「360p」を選択したときと同じ画質。 + - `medium`: ATOM アプリで「SD」を選択したときと同じ画質。 + - `high`: ATOM アプリで「HD (1080p)」を選択したときと同じ画質。 + enum: + - low + - medium + - high + type: string + type: object + SoraCamAtomCamSettingsRotation: + properties: + state: + description: | + 画像を 180° 回転させる設定。ソラカメ対応カメラを上下反対に設置した場合に `180` を設定します。 + + - `0`: OFF (回転なし)。 + - `180`: ON (180° 回転)。 + enum: + - 0 + - 180 + type: integer + type: object + SoraCamAtomCamSettingsStatusLight: + properties: + state: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定。 + + - `on`: 点灯。 + - `off`: 消灯。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsTimestamp: + properties: + state: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object SoraCamDevice: properties: appliedLicenses: @@ -19971,6 +21411,11 @@ components: - `storage_life`: 保存期間 type: string type: object + SoraCamDeviceName: + properties: + name: + type: string + type: object SoraCamEvent: properties: deviceId: @@ -20143,12 +21588,12 @@ components: SoraCamLicensePackQuantityUpdatingRequest: properties: currentQuantity: - description: 現在のライセンス数 + description: 現在のライセンス数。 example: 1 format: int32 type: integer desiredQuantity: - description: 変更後のライセンス数 + description: 変更後のライセンス数。 example: 2 format: int32 type: integer @@ -20156,20 +21601,20 @@ components: SoraCamLicensePackResponse: properties: id: - description: ライセンスパックの ID + description: ライセンスパックの ID。 example: CR7-SC type: string name: - description: ライセンスパックの名前 + description: ライセンスパックの名前。 example: Cloud Recording License (7 Days) type: string quantity: - description: 現在のライセンス数 + description: 現在のライセンス数。 example: 1 format: int32 type: integer salesChannel: - description: ライセンスパックの販売元 + description: ライセンスパックの販売元。 example: SORACOM Inc. type: string type: object @@ -20193,6 +21638,60 @@ components: - 録画映像を取得しようとした場合に、指定した `from` から `to` の間に録画映像が存在しない。 type: string type: object + SoraCamPowerState: + properties: + powerState: + description: | + ソラカメ対応カメラの電源状態。 + + - `on`: 電源オン + - `sleep`: スリープ + enum: + - "on" + - sleep + type: string + type: object + SoraCamRecordingsAndEventsList: + properties: + events: + items: + properties: + endTime: + description: イベントの終了時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + startTime: + description: イベントの開始時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + type: + description: | + イベント種別。 + + - `motion`: モーション検知。 + - `sound`: サウンド検出。 + - `other`: その他。 + enum: + - motion + - sound + - other + type: string + type: object + type: array + records: + items: + properties: + endTime: + description: 録画の終了時刻 (UNIX 時間 (ミリ秒))。録画中の場合は、`endTime` が含まれません。 + format: int64 + type: integer + startTime: + description: 録画の開始時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + type: object + type: array + type: object SoraCamStreamingVideo: properties: expiryTime: @@ -20604,7 +22103,7 @@ components: type: string type: array type: - description: 通知種別 + description: メールアドレスの種類。 enum: - primary - recovery @@ -20618,12 +22117,7 @@ components: TagSet: additionalProperties: type: string - description: An object which always contains at least one property "name" with - a string value. If you give a subscriber/SIM a name, the name will be returned - as the value of the "name" property. If the subscriber/SIM does not have a - name, an empty string "" is returned. In addition, if you create any custom - tags for the subscriber/SIM, each custom tag will appear as additional properties - in the object. + description: 任意のタグを設定できます。name プロパティに指定した値が、IoT SIM やグループなどのオブジェクトの名前として扱われます。 example: tagName1: tagValue1 tagName2: tagValue2... @@ -20676,17 +22170,25 @@ components: speedClass: description: | 速度クラス。以下のいずれかを指定します。ただし、サブスクリプションにあわせた速度クラスを指定してください。 - - plan01s、plan01s - Low Data Volume、planP1、planX3 X3-5MB、plan-D の場合: + + - plan01s、plan01s - Low Data Volume、planX3 X3-5MB、planP1、plan-D (バンドルなし)、plan-D D-300MB、plan-K2 K2-300MB、plan-K の場合: - `s1.minimum` - `s1.slow` - `s1.standard` - `s1.fast` - `s1.4xfast` - - plan-KM1 の場合: - - `t1.standard` + - plan-US の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` - plan-DU の場合: - `u1.standard` - `u1.slow` + - plan-KM1 の場合: + - `t1.standard` - バーチャル SIM/Subscriber の場合: - `arc.standard` enum: @@ -20695,9 +22197,10 @@ components: - s1.standard - s1.fast - s1.4xfast - - t1.standard + - s1.8xfast - u1.standard - u1.slow + - t1.standard - arc.standard type: string required: @@ -20736,14 +22239,7 @@ components: VerifyAddEmailTokenRequest: properties: token: - description: メールで送信されたトークン - type: string - required: - - token - type: object - VerifyOperatorsRequest: - properties: - token: + description: メールで送信されたトークン。 type: string required: - token @@ -20814,21 +22310,22 @@ components: placement: $ref: '#/components/schemas/Placement' primaryServiceName: - description: (非推奨) + description: (非推奨) このプロパティは使用されていません。 type: string sessionStats: properties: lastUpdatedAt: - description: セッション数の集計日時 (UNIX 時間 (ミリ秒))。なお、オンラインのセッション数は定期的に集計しているため、リアルタイムの数値ではありません。 + description: セッション数の集計日時 (UNIX 時間 (ミリ秒))。 format: int64 type: integer online: description: VPG を利用する IoT SIM とバーチャル SIM/Subscriber のうち、セッションが "オンライン" - になっている IoT SIM とバーチャル SIM/Subscriber の数。 + になっている IoT SIM とバーチャル SIM/Subscriber の数。なお、オンラインのセッション数は定期的に集計しているため、リアルタイムの数値ではありません。この数値が更新された日時は、lastUpdatedAt + で確認できます。 type: integer type: object size: - description: (非推奨) VPG サイズ + description: (非推奨) このプロパティは使用されていません。 type: string status: enum: @@ -20866,7 +22363,7 @@ components: description: ID type: string vpgSubnetCidrRange: - description: VPG IP アドレスレンジ。VPG に割り当てられる IP アドレスの範囲です。 + description: VPG に割り当てられる IP アドレスの範囲です。SORACOM Door または SORACOM Direct を利用する際に必要です。 type: string type: object VolumeDiscountModel: @@ -20980,7 +22477,7 @@ tags: name: DeviceObjectModel - description: '[SORACOM Inventory デバイス](/ja-jp/docs/inventory/)' name: Device -- description: '[診断機能](/ja-jp/docs/diagnostic/)' +- description: '[診断機能](/ja-jp/guides/diagnostic/)' name: Diagnostic - description: '[イベントハンドラー](/ja-jp/docs/event-handler/)' name: EventHandler diff --git a/go.mod b/go.mod index d06a5b3c..c43a8c7a 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/spf13/cobra v1.2.1 github.com/stretchr/testify v1.7.0 github.com/tj/assert v0.0.3 - golang.org/x/sys v0.12.0 + golang.org/x/sys v0.14.0 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 gopkg.in/yaml.v2 v2.4.0 ) diff --git a/go.sum b/go.sum index 5e03de48..1556a01b 100644 --- a/go.sum +++ b/go.sum @@ -426,6 +426,8 @@ golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q= +golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= diff --git a/soracom/generated/cmd/assets/cli/en.yaml b/soracom/generated/cmd/assets/cli/en.yaml index dc8d6094..465c1a06 100644 --- a/soracom/generated/cmd/assets/cli/en.yaml +++ b/soracom/generated/cmd/assets/cli/en.yaml @@ -3,6 +3,9 @@ cli: audit-logs: summary: Retrieve audit logs. description: Retrieve audit logs. + api: + summary: Retrieve audit logs for API. + description: Retrieve audit logs for API. napter: summary: Retrieve audit logs for Napter. description: Retrieve audit logs for Napter. @@ -12,6 +15,9 @@ cli: bills: summary: Show or export billing info. description: Show billing info for specified period, or export the billing info to a file + summaries: + summary: Get summarized billing information. + description: Get summarized billing information. cell-locations: summary: Retrieves cell tower location information. description: Retrieves cell tower location information. @@ -34,6 +40,7 @@ cli: configure: summary: Show, create or update configurations (profiles). description: Show, create or update configurations (profiles). + overwrite: Overwrites profile information even if it already exists. profile: permission_is_too_open: "Permissions for the file '%s' which contains your credentials are too open.\nIt is required that your credential files are NOT accessible by others." prompt: "--- SORACOM CLI setup ---\nThis will create a directory %s if it does not exist yet and place '%s.json' in it." @@ -172,9 +179,15 @@ cli: auth-keys: summary: List, create or delete operator's AuthKeys. description: List, create or delete operator's AuthKeys. + configuration: + summary: List, create or delete operator's configuration. + description: List, create or delete operator's configuration. orders: summary: List, create or cancel orders. description: List, create or cancel orders. + resource-initial-setting: + summary: Manage initial settings for ordered products. + description: Manage initial settings for ordered products. payer-information: summary: Get or edit payer information. description: Get or edit payer information. @@ -254,12 +267,21 @@ cli: devices: summary: Manage SoraCam devices. description: Manage SoraCam devices. + atomcam: + summary: Performs operations specific to the ATOM Cam series camera devices. + description: Performs operations specific to the ATOM Cam series camera devices. + settings: + summary: Manage settings specific to the ATOM Cam series camera devices. + description: Manage settings specific to the ATOM Cam series camera devices. events: summary: Retrieve event history for SoraCam devices. description: Retrieve event history for SoraCam devices. images: summary: Manage image exports from SoraCam devices. description: Manage image exports from SoraCam devices. + recordings-and-events: + summary: Obtains recording status of cloud continuous recording and event occurrences for SoraCam devices. + description: Obtains recording status of cloud continuous recording and event occurrences for SoraCam devices. videos: summary: Manage video exports from SoraCam devices. description: Manage video exports from SoraCam devices. @@ -272,15 +294,33 @@ cli: air: summary: Show or export Air statistics. description: Show or export Air statistics. + groups: + summary: Get data usage history aggregating all IoT SIMs belonging to the specified group. + description: Get data volume history aggregating all IoT SIMs belonging to the specified group. + operators: + summary: Get data usage history aggregated across all IoT SIMs owned by the specified operator. + description: Get data usage history aggregated across all IoT SIMs owned by the specified operator. sims: summary: Show or export Air statistics by SIM ID. description: Show or export Air statistics by SIM ID. beam: summary: Show or export Beam statistics. description: Show or export Beam statistics. + funk: + summary: Perform operations related to SORACOM Funk usage history. + description: Perform operations related to SORACOM Funk usage history. + funnel: + summary: Perform operations related to SORACOM Funnel usage history. + description: Perform operations related to SORACOM Funnel usage history. harvest: summary: Get usage report for Harvest. description: Get usage report for Harvest. + operators: + summary: Perform per-operator operations on SORACOM Harvest Data usage statistics. + description: Perform per-operator operations on SORACOM Harvest Data usage statistics. + subscribers: + summary: Get SORACOM Harvest Data usage history for the subscriber specified by IMSI. + description: Get SORACOM Harvest Data usage history for the subscriber specified by IMSI. napter: summary: Get usage report for Napter. description: Get usage report for Napter. diff --git a/soracom/generated/cmd/assets/cli/ja.yaml b/soracom/generated/cmd/assets/cli/ja.yaml index 07965bd5..1e493cb9 100644 --- a/soracom/generated/cmd/assets/cli/ja.yaml +++ b/soracom/generated/cmd/assets/cli/ja.yaml @@ -3,6 +3,9 @@ cli: audit-logs: summary: 監査ログを取得します。 description: 監査ログを取得します。 + api: + summary: API の監査ログを取得します。 + description: API の監査ログを取得します。 napter: summary: Napter の監査ログを取得します。 description: Napter の監査ログを取得します。 @@ -12,6 +15,9 @@ cli: bills: summary: 課金に関する情報を確認したりファイルへのエクスポートを行います。 description: 課金に関する情報を確認したりファイルへのエクスポートを行います。 + summaries: + summary: 要約された課金情報を取得します。 + description: 要約された課金情報を取得します。 cell-locations: summary: 基地局の位置情報を取得します。 description: 基地局の位置情報を取得します。 @@ -32,8 +38,9 @@ cli: summary: zsh 用の補完 (completion) スクリプトを生成します。 description: zsh 用の補完 (completion) スクリプトを生成します。 configure: - summary: コマンド実行環境（プロファイル）の設定や表示を行います。 - description: コマンド実行環境（プロファイル）の設定や表示を行います。 + summary: コマンド実行環境 (プロファイル) の設定や表示を行います。 + description: コマンド実行環境 (プロファイル) の設定や表示を行います。 + overwrite: プロファイル情報がすでに存在していても上書きします。 profile: permission_is_too_open: "認証情報ファイル %s へのアクセス権が十分に絞り込まれていません。\n認証情報ファイルへは、soracom コマンドを実行しているユーザーのみがアクセス可能なように設定する必要があります。" prompt: "--- SORACOM CLI セットアップ ---\n%s ディレクトリがなければ作成し、そこにファイル '%s.json' を作成します。" @@ -45,9 +52,9 @@ cli: 認証方法を選択してください。 - 1. AuthKeyId と AuthKey を入力する（推奨） + 1. AuthKeyId と AuthKey を入力する (推奨) 2. オペレーターのメールアドレスとパスワードを入力する - 3. SAM ユーザーの認証情報を入力する（オペレーターID、ユーザー名、パスワード） + 3. SAM ユーザーの認証情報を入力する (オペレーターID、ユーザー名、パスワード) 4. スイッチユーザー select: "選択してください (1-4) > " @@ -59,10 +66,10 @@ cli: summary: プロファイル情報を表示します。 description: プロファイル情報を表示します。 configure_sandbox: - summary: API Sandbox 用のコマンド実行環境（プロファイル）の設定を行います。 - description: API Sandbox 用のコマンド実行環境（プロファイル）の設定を行います。 - auth_key: 本番環境のアカウントの AuthKey（本番環境のアカウントを持っているかどうかを確認するために使われます） - auth_key_id: 本番環境のアカウントの AuthKeyId（本番環境のアカウントを持っているかどうかを確認するために使われます） + summary: API Sandbox 用のコマンド実行環境 (プロファイル) の設定を行います。 + description: API Sandbox 用のコマンド実行環境 (プロファイル) の設定を行います。 + auth_key: 本番環境のアカウントの AuthKey (本番環境のアカウントを持っているかどうかを確認するために使われます) + auth_key_id: 本番環境のアカウントの AuthKeyId (本番環境のアカウントを持っているかどうかを確認するために使われます) email: API Sandbox 環境に作られるユーザーのメールアドレス overwrite: プロファイルが既に存在する場合、それを上書きするかどうかを指定します。 password: API Sandbox 環境に作られるユーザーのパスワード @@ -125,7 +132,7 @@ cli: coverage-type: | カバレッジタイプを指定します。グローバルカバレッジは 'g'、日本カバレッジは 'jp' です。 no-retry-on-error: | - このフラグを指定すると、API がエラーを返してきた場合にもリトライしません（デフォルトではバックオフしながら数回リトライします）。 + このフラグを指定すると、API がエラーを返してきた場合にもリトライしません (デフォルトではバックオフしながら数回リトライします)。 profile: | プロファイル名を指定します。 profile-command: | @@ -134,7 +141,7 @@ cli: すなわち事前に 'soracom configure' コマンドを実行しておく必要がなくなります。 認証情報をパスワードマネージャーなどのより安全な場所に格納しておき、外部コマンド経由でそれを利用することができます。 raw-output: | - API から返却されたレスポンスを加工せずにそのまま出力します（デフォルトでは JSON をインデントして表示します）。 + API から返却されたレスポンスを加工せずにそのまま出力します (デフォルトでは JSON をインデントして表示します)。 groups: summary: グループに関する操作を行います。 description: グループに関する操作を行います。 @@ -172,9 +179,15 @@ cli: auth-keys: summary: オペレーターの認証キーに関する操作を行います。 description: オペレーターの認証キーに関する操作を行います。 + configuration: + summary: オペレーター全体に関わるコンフィグレーションに関する操作を行います。 + description: オペレーター全体に関わるコンフィグレーションに関する操作を行います。 orders: summary: 商品の注文に関する操作を行います。 description: 商品の注文に関する操作を行います。 + resource-initial-setting: + summary: 発注した商品に対する初期設定を管理する + description: 発注した商品に対する初期設定を管理します。 payer-information: summary: 課金明細に出力する支払い者情報を取得または設定します。 description: 課金明細に出力する支払い者情報を取得または設定します。 @@ -197,8 +210,8 @@ cli: summary: 商品一覧を取得します。 description: 商品一覧を取得します。 query: - summary: リソース（サブスクライバー、Sigfox デバイス）をいろいろな条件で検索します。 - description: いろいろな条件を指定して、その条件に適合するリソース（サブスクライバー、Sigfox デバイス）を抽出します。 + summary: リソース (サブスクライバー、Sigfox デバイス) をいろいろな条件で検索します。 + description: いろいろな条件を指定して、その条件に適合するリソース (サブスクライバー、Sigfox デバイス) を抽出します。 refer-api-reference: このコマンドの引数およびレスポンスについての詳細は、https://users.soracom.io/ja-jp/tools/api/reference/#/%s/%s を参照してください。 resource-summaries: summary: リソースの要約を取得します。 @@ -231,38 +244,65 @@ cli: summary: Soracom Cloud Camera Services のライセンスパックに関する操作を行います。 description: Soracom Cloud Camera Services のライセンスパックに関する操作を行います。 devices: - summary: ソラカメ対応カメラデバイスに関する操作を行います。 - description: ソラカメ対応カメラデバイスに関する操作を行います。 + summary: ソラカメ対応カメラに関する操作を行います。 + description: ソラカメ対応カメラに関する操作を行います。 + atomcam: + summary: ATOM Cam シリーズのソラカメ対応カメラに固有の操作をする + description: ATOM Cam シリーズのソラカメ対応カメラに固有の操作を行います。 + settings: + summary: ATOM Cam シリーズのソラカメ対応カメラに固有の設定を管理します。 + description: ATOM Cam シリーズのソラカメ対応カメラに固有の設定を管理します。 events: - summary: ソラカメ対応カメラデバイスで検出されたイベントの一覧を取得します。 - description: ソラカメ対応カメラデバイスで検出されたイベントの一覧を取得します。 + summary: ソラカメ対応カメラで検出されたイベントの一覧を取得します。 + description: ソラカメ対応カメラで検出されたイベントの一覧を取得します。 images: - summary: ソラカメ対応カメラデバイスからの静止画のエクスポートに関する操作を行います。 - description: ソラカメ対応カメラデバイスからの静止画のエクスポートに関する操作を行います。 + summary: ソラカメ対応カメラからの静止画のエクスポートに関する操作を行います。 + description: ソラカメ対応カメラからの静止画のエクスポートに関する操作を行います。 + recordings-and-events: + summary: ソラカメ対応カメラのクラウド常時録画の録画状況とイベント発生日時の情報を合わせて取得する + description: ソラカメ対応カメラのクラウド常時録画の録画状況とイベント発生日時の情報を合わせて取得します。 videos: - summary: ソラカメ対応カメラデバイスからの動画のエクスポートに関する操作を行います。 - description: ソラカメ対応カメラデバイスからの動画のエクスポートに関する操作を行います。 + summary: ソラカメ対応カメラからの動画のエクスポートに関する操作を行います。 + description: ソラカメ対応カメラからの動画のエクスポートに関する操作を行います。 soralets: summary: Orbit の Soralet に関する操作を行います。 description: Orbit の Soralet に関する操作を行います。 stats: - summary: 統計情報に関する操作を行います。 - description: 統計情報に関する操作を行います。 + summary: 統計情報 (利用量履歴) に関する操作をする + description: 統計情報 (利用量履歴) に関する操作を行います。 air: - summary: Air の統計情報に関する操作を行います。 - description: Air の統計情報に関する操作を行います。 + summary: SORACOM Air の通信量履歴に関する操作をする + description: SORACOM Air の通信量履歴に関する操作をします。 + groups: + summary: 指定したグループに所属するすべての IoT SIM を集約したデータ通信量履歴を取得する + description: 指定したグループに所属するすべての IoT SIM を集約したデータ通信量履歴を取得します。 + operators: + summary: 指定したオペレーターが保有するすべての IoT SIM を集約したデータ通信量履歴を取得する + description: 指定したオペレーターが保有するすべての IoT SIM を集約したデータ通信量履歴を取得します。 sims: - summary: SIM ID で Air の統計情報に関する操作を行います。 - description: SIM ID で Air の統計情報に関する操作を行います。 + summary: SIM ID で指定した IoT SIM の通信量履歴を取得する + description: SIM ID で指定した IoT SIM の通信量履歴を取得します。 beam: - summary: Beam の統計情報に関する操作を行います。 - description: Beam の統計情報に関する操作を行います。 + summary: SORACOM Beam の利用量履歴に関する操作をする + description: SORACOM Beam の利用量履歴に関する操作をします。 + funk: + summary: SORACOM Funk の利用量履歴に関する操作をする + description: SORACOM Funk の利用量履歴に関する操作をします。 + funnel: + summary: SORACOM Funnel の利用量履歴に関する操作をする + description: SORACOM Funk の利用量履歴に関する操作をします。 harvest: - summary: Harvest の利用統計情報を取得します。 - description: Harvest の利用統計情報を取得します。 + summary: SORACOM Harvest の利用統計情報に関する操作をする + description: SORACOM Harvest の利用統計情報に関する操作をします。 + operators: + summary: オペレーター単位の SORACOM Harvest Data 利用統計情報に関する操作をする + description: オペレーター単位の SORACOM Harvest Data 利用統計情報に関する操作をします。 + subscribers: + summary: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得する + description: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得します。 napter: - summary: Napter の利用統計情報を取得します。 - description: Napter の利用統計情報を取得します。 + summary: SORACOM Napter の利用統計情報を取得する。 + description: SORACOM Napter の利用統計情報を取得します。 audit-logs: summary: Napter 監査ログの利用統計情報を取得します。 description: Napter 監査ログの利用統計情報を取得します。 @@ -279,8 +319,8 @@ cli: summary: 常に 500 Internal server error を返す API を呼び、リトライ処理が期待通りに動作するかどうかを確認します。 description: 常に 500 Internal server error を返す API を呼び、リトライ処理が期待通りに動作するかどうかを確認します。環境変数 SORACOM_VERBOSE=1 を指定した状態で実行するとよいでしょう。 unconfigure: - summary: コマンド実行環境（プロファイル）を削除します。 - description: コマンド実行環境（プロファイル）を削除します。 + summary: コマンド実行環境 (プロファイル) を削除します。 + description: コマンド実行環境 (プロファイル) を削除します。 prompt: "プロファイル %s を削除します。よろしいですか？ (y/N) " users: summary: SAM ユーザーに関する操作を行います。 @@ -307,8 +347,8 @@ cli: summary: バージョン情報を表示します。 description: バージョン情報を表示します。 volume-discounts: - summary: ボリュームディスカウント（長期利用割引）に関する操作を行います。 - description: ボリュームディスカウント（長期利用割引）に関する操作を行います。 + summary: ボリュームディスカウント (長期利用割引) に関する操作を行います。 + description: ボリュームディスカウント (長期利用割引) に関する操作を行います。 vpg: summary: VPG に関する操作を行います。 description: VPG (Virtual Private Gateways) に関する操作を行います。 diff --git a/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.en.yaml b/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.en.yaml index 85b4833b..cdd8b77b 100644 --- a/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.en.yaml +++ b/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.en.yaml @@ -2,26 +2,12 @@ openapi: 3.0.0 info: description: SORACOM SANDBOX API v1 title: SORACOM SANDBOX API - version: 20230507-231147 + version: 20230923-005714 servers: - - url: 'https://api-sandbox.soracom.io/v1' +- url: https://api-sandbox.soracom.io/v1 paths: /sandbox/coupons/create: post: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxCreateCouponResponse' - description: OK - '400': - description: Request is not correct. - security: - - api_key: [] - api_token: [] - tags: - - Coupon description: Creates a coupon. operationId: sandboxCreateCoupon requestBody: @@ -31,29 +17,31 @@ paths: $ref: '#/components/schemas/sandboxCreateCouponRequest' description: request required: true - summary: Creates a coupon - x-soracom-cli: - - sandbox coupons create - /sandbox/init: - post: responses: - '201': + "200": content: application/json: schema: - $ref: '#/components/schemas/sandboxAuthResponse' - description: Successfully created a sandbox operator. - '400': - description: 'Email address, AuthKeyId, or AuthKey is not correct.' + $ref: '#/components/schemas/sandboxCreateCouponResponse' + description: OK + "400": + description: Request is not correct. + security: + - api_key: [] + api_token: [] + summary: Creates a coupon tags: - - Operator - description: >- - Performs complex signup process at once, including registering dummy - payment method. Specify `email` and `password` for an operator which - will be created on sandbox, `authKeyId` and `authKey` for a real - operator on the production environment. An API Key and an API Token will - be included in the response if successful. Use the API Key and the API - Token to requests afterwards. + - 'API Sandbox: Coupon' + x-soracom-cli: + - sandbox coupons create + /sandbox/init: + post: + description: Performs complex signup process at once, including registering + dummy payment method. Specify `email` and `password` for an operator which + will be created on sandbox, `authKeyId` and `authKey` for a real operator + on the production environment. An API Key and an API Token will be included + in the response if successful. Use the API Key and the API Token to requests + afterwards. operationId: sandboxInitializeOperator requestBody: content: @@ -62,82 +50,81 @@ paths: $ref: '#/components/schemas/sandboxInitRequest' description: request required: true - summary: Creates an operator account. - x-soracom-cli: - - sandbox init - '/sandbox/operators/token/{email}': - post: - parameters: - - description: email - in: path - name: email - required: true - schema: - type: string responses: - '200': + "201": content: application/json: schema: - $ref: '#/components/schemas/sandboxGetSignupTokenResponse' - description: Successfully retrieved signup token. - '400': - description: 'Email address, AuthKeyId, or AuthKey is not correct.' + $ref: '#/components/schemas/sandboxAuthResponse' + description: Successfully created a sandbox operator. + "400": + description: Email address, AuthKeyId, or AuthKey is not correct. + summary: Creates an operator account tags: - - Operator - description: >- - Retrieves a 'signup token' for registration confirmation. Please specify - a pair of AuthKeyId and AuthKey of a SAM user on the production - environment to check if the caller has a valid account on it. - operationId: sandboxGetSignupToken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxGetSignupTokenRequest' - description: Authentication request - required: true - summary: Gets a signup token + - 'API Sandbox: Operator' x-soracom-cli: - - sandbox operators get-signup-token - '/sandbox/operators/{operator_id}': + - sandbox init + /sandbox/operators/{operator_id}: delete: + description: Deletes the specified operator. + operationId: sandboxDeleteOperator parameters: - - description: Operator ID - in: path - name: operator_id - required: true - schema: - type: string + - description: Operator ID + in: path + name: operator_id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '400': + "400": description: Operator does not exist. security: - - api_key: [] - api_token: [] - tags: - - Operator - description: Deletes the specified operator. - operationId: sandboxDeleteOperator + - api_key: [] + api_token: [] summary: Deletes an operator + tags: + - 'API Sandbox: Operator' x-soracom-cli: - - sandbox operators delete - /sandbox/orders/ship: + - sandbox operators delete + /sandbox/operators/token/{email}: post: + description: Retrieves a 'signup token' for registration confirmation. Please + specify a pair of AuthKeyId and AuthKey of a SAM user on the production environment + to check if the caller has a valid account on it. + operationId: sandboxGetSignupToken + parameters: + - description: Email + in: path + name: email + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxGetSignupTokenRequest' + description: Authentication request. + required: true responses: - '200': - description: OK - '400': - description: Order does not exist. - security: - - api_key: [] - api_token: [] + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxGetSignupTokenResponse' + description: Successfully retrieved signup token. + "400": + description: Email address, AuthKeyId, or AuthKey is not correct. + summary: Gets a signup token tags: - - Order - description: >- - Changes the shipping status to 'shipped' and gets ready the subscribers + - 'API Sandbox: Operator' + x-soracom-cli: + - sandbox operators get-signup-token + /sandbox/orders/ship: + post: + description: Changes the shipping status to 'shipped' and gets ready the subscribers included in the order. operationId: sandboxShipOrder requestBody: @@ -147,33 +134,32 @@ paths: $ref: '#/components/schemas/sandboxShipOrderRequest' description: Shipping request required: true - summary: Ships the specified order. - x-soracom-cli: - - sandbox orders ship - '/sandbox/stats/air/subscribers/{imsi}': - post: - parameters: - - description: IMSI - in: path - name: imsi - required: true - schema: - type: string responses: - '200': + "200": description: OK - '400': - description: Data with the same timestamp already exists. + "400": + description: Order does not exist. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Ships the specified order tags: - - Stats - description: >- - Populates Air stats for testing purpose. Inserted data are going to be - automatically accumulated. It is not possible to put the data multiple + - 'API Sandbox: Order' + x-soracom-cli: + - sandbox orders ship + /sandbox/stats/air/subscribers/{imsi}: + post: + description: Populates Air stats for testing purpose. Inserted data are going + to be automatically accumulated. It is not possible to put the data multiple times with the same timestamp. operationId: sandboxInsertAirStats + parameters: + - description: IMSI. + in: path + name: imsi + required: true + schema: + type: string requestBody: content: application/json: @@ -181,33 +167,32 @@ paths: $ref: '#/components/schemas/sandboxInsertAirStatsRequest' description: The Air stats (up/down bytes of data) with specified timestamp. required: true - summary: Inserts Air stats for testing - x-soracom-cli: - - sandbox stats air insert - '/sandbox/stats/beam/subscribers/{imsi}': - post: - parameters: - - description: IMSI - in: path - name: imsi - required: true - schema: - type: string responses: - '200': + "200": description: OK - '400': + "400": description: Data with the same timestamp already exists. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Inserts Air stats for testing tags: - - Stats - description: >- - Populates Beam stats for testing purpose. Inserted data are going to be - automatically accumulated. It is not possible to put the data multiple + - 'API Sandbox: Stats' + x-soracom-cli: + - sandbox stats air insert + /sandbox/stats/beam/subscribers/{imsi}: + post: + description: Populates Beam stats for testing purpose. Inserted data are going + to be automatically accumulated. It is not possible to put the data multiple times with the same timestamp. operationId: sandboxInsertBeamStats + parameters: + - description: IMSI. + in: path + name: imsi + required: true + schema: + type: string requestBody: content: application/json: @@ -215,43 +200,53 @@ paths: $ref: '#/components/schemas/sandboxInsertBeamStatsRequest' description: The Beam stats (number of requests) with specified timestamp. required: true - summary: Inserts Beam stats for testing - x-soracom-cli: - - sandbox stats beam insert - /sandbox/subscribers/create: - post: responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/sandboxCreateSubscriberResponse' + "200": description: OK + "400": + description: Data with the same timestamp already exists. security: - - api_key: [] - api_token: [] + - api_key: [] + api_token: [] + summary: Inserts Beam stats for testing tags: - - Subscriber + - 'API Sandbox: Stats' + x-soracom-cli: + - sandbox stats beam insert + /sandbox/subscribers/create: + post: description: Creates a new subscriber for sandbox. operationId: sandboxCreateSubscriber requestBody: content: application/json: examples: - Creating "plan01s": - value: - subscription: plan01s Creating "plan-D D-300MB": value: bundle: - D-300MB subscription: plan-D + Creating "plan01s": + value: + subscription: plan01s schema: $ref: '#/components/schemas/sandboxCreateSubscriberRequest' description: Create request - summary: Creates a new subscriber for sandbox. + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/sandboxCreateSubscriberResponse' + description: OK + security: + - api_key: [] + api_token: [] + summary: Creates a new subscriber for sandbox + tags: + - 'API Sandbox: Subscriber' x-soracom-cli: - - sandbox subscribers create + - sandbox subscribers create components: schemas: TagSet: @@ -283,9 +278,9 @@ components: type: integer applicableBillItemName: enum: - - dailyDataTrafficChargeTotal - - dailyChargeTotal - - dailySoracomBeamRequestChargeTotal + - dailyDataTrafficChargeTotal + - dailyChargeTotal + - dailySoracomBeamRequestChargeTotal example: dailyDataTrafficChargeTotal type: string expiryYearMonth: @@ -295,29 +290,28 @@ components: sandboxCreateCouponResponse: properties: amount: - description: Coupon amount + description: Coupon amount. format: double type: number balance: - description: Balance + description: Balance. format: double type: number billItemName: - description: Bill Item + description: Bill Item. type: string couponCode: - description: Coupon code + description: Coupon code. type: string expiryYearMonth: - description: Year and month of expiration + description: Year and month of expiration. format: yyyyMM type: string type: object sandboxCreateSubscriberRequest: properties: bundles: - description: "Bundle. If necessary, specify one of:" - type: array + description: 'Bundle. If necessary, specify one of:' items: enum: - X3-5MB @@ -327,8 +321,9 @@ components: - DU-100GB - K2-300MB type: string + type: array subscription: - description: "Subscription. Specify one of:" + description: 'Subscription. Specify one of:' enum: - plan01s - plan01s-low_data_volume @@ -343,8 +338,6 @@ components: type: object sandboxCreateSubscriberResponse: properties: - tags: - $ref: '#/components/schemas/TagSet' apn: type: string createdAt: @@ -374,6 +367,8 @@ components: type: string subscription: type: string + tags: + $ref: '#/components/schemas/TagSet' type: object sandboxDataTrafficStats: properties: @@ -402,7 +397,7 @@ components: token: type: string required: - - token + - token type: object sandboxInitRequest: properties: @@ -429,26 +424,32 @@ components: default: true type: boolean required: - - email - - password - - authKeyId - - authKey + - email + - password + - authKeyId + - authKey type: object sandboxInsertAirStatsRequest: properties: dataTrafficStatsMap: - properties: - s1.fast: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.minimum: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.slow: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.standard: - $ref: '#/components/schemas/sandboxDataTrafficStats' + additionalProperties: + $ref: '#/components/schemas/sandboxDataTrafficStats' + description: | + Test data for each speed class, including data for both upload and download, with timestamps. Specify a string representing the speed class as a key. + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` type: object unixtime: - description: UNIX time (in milliseconds) + description: UNIX time (in seconds). format: int64 type: integer type: object @@ -480,7 +481,7 @@ components: $ref: '#/components/schemas/sandboxBeamCounts' type: object unixtime: - description: UNIX time (in milliseconds) + description: UNIX time (in seconds). format: int64 type: integer type: object @@ -491,9 +492,12 @@ components: orderId: type: string required: - - orderId - - operatorId + - orderId + - operatorId type: object - tags: -- name: Coupon +- name: 'API Sandbox: Coupon' +- name: 'API Sandbox: Operator' +- name: 'API Sandbox: Order' +- name: 'API Sandbox: Stats' +- name: 'API Sandbox: Subscriber' diff --git a/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.ja.yaml b/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.ja.yaml index 1eb0af13..0801d1f5 100644 --- a/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.ja.yaml +++ b/soracom/generated/cmd/assets/sandbox/soracom-sandbox-api.ja.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM SANDBOX API v1 title: SORACOM SANDBOX API - version: 20230703-214017 + version: 20230923-005714 servers: - url: https://api-sandbox.soracom.io/v1 paths: @@ -31,7 +31,7 @@ paths: api_token: [] summary: クーポンを作成する tags: - - Coupon + - 'API Sandbox: Coupon' x-soracom-cli: - sandbox coupons create /sandbox/init: @@ -58,7 +58,7 @@ paths: description: メールアドレスが不正もしくは AuthKeyId, AuthKey が誤っている。 summary: Operator を初期化する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox init /sandbox/operators/{operator_id}: @@ -82,7 +82,7 @@ paths: api_token: [] summary: Operator を削除する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox operators delete /sandbox/operators/token/{email}: @@ -115,7 +115,7 @@ paths: description: メールアドレス、AuthKeyId、AuthKey のいずれかが誤っている。 summary: サインアップトークンを取得する tags: - - Operator + - 'API Sandbox: Operator' x-soracom-cli: - sandbox operators get-signup-token /sandbox/orders/ship: @@ -139,7 +139,7 @@ paths: api_token: [] summary: Order を出荷済状態にする tags: - - Order + - 'API Sandbox: Order' x-soracom-cli: - sandbox orders ship /sandbox/stats/air/subscribers/{imsi}: @@ -170,7 +170,7 @@ paths: api_token: [] summary: テスト用に Air の統計情報を登録する tags: - - Stats + - 'API Sandbox: Stats' x-soracom-cli: - sandbox stats air insert /sandbox/stats/beam/subscribers/{imsi}: @@ -201,7 +201,7 @@ paths: api_token: [] summary: テスト用に Beam の統計情報を登録する tags: - - Stats + - 'API Sandbox: Stats' x-soracom-cli: - sandbox stats beam insert /sandbox/subscribers/create: @@ -235,7 +235,7 @@ paths: api_token: [] summary: Subscriber を作成する tags: - - Subscriber + - 'API Sandbox: Subscriber' x-soracom-cli: - sandbox subscribers create components: @@ -423,18 +423,24 @@ components: sandboxInsertAirStatsRequest: properties: dataTrafficStatsMap: - properties: - s1.fast: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.minimum: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.slow: - $ref: '#/components/schemas/sandboxDataTrafficStats' - s1.standard: - $ref: '#/components/schemas/sandboxDataTrafficStats' + additionalProperties: + $ref: '#/components/schemas/sandboxDataTrafficStats' + description: | + 速度クラスごとのテスト用データ (上り下りのデータ通信量、タイムスタンプ付き) です。キーに速度クラスを表す文字列を指定します。 + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` type: object unixtime: - description: UNIX 時間（ミリ秒単位） + description: UNIX 時間 (秒)。 format: int64 type: integer type: object @@ -466,7 +472,7 @@ components: $ref: '#/components/schemas/sandboxBeamCounts' type: object unixtime: - description: UNIX 時間（ミリ秒単位） + description: UNIX 時間 (秒)。 format: int64 type: integer type: object @@ -481,4 +487,8 @@ components: - operatorId type: object tags: -- name: Coupon +- name: 'API Sandbox: Coupon' +- name: 'API Sandbox: Operator' +- name: 'API Sandbox: Order' +- name: 'API Sandbox: Stats' +- name: 'API Sandbox: Subscriber' diff --git a/soracom/generated/cmd/assets/soracom-api.en.yaml b/soracom/generated/cmd/assets/soracom-api.en.yaml index 31ffd35d..4f88a175 100644 --- a/soracom/generated/cmd/assets/soracom-api.en.yaml +++ b/soracom/generated/cmd/assets/soracom-api.en.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM API v1 title: SORACOM API - version: 20230704-081118 + version: 20231114-075713 servers: - description: Japan coverage production API url: https://api.soracom.io/v1 @@ -11,10 +11,10 @@ servers: paths: /audit_logs/api: get: - description: Retrieve audit logs for API calls. + description: Retrieve audit logs for Soracom API calls. operationId: getApiAuditLogs parameters: - - description: Filter item for audit log retrieval by API kind. + - description: Filter item for audit log retrieval by API kind (e.g. `/v1/auth`). in: query name: api_kind required: false @@ -65,11 +65,11 @@ paths: items: $ref: '#/components/schemas/APIAuditLogEntry' type: array - description: A list of API audit log entries. + description: A list of Soracom API audit log entries. security: - api_key: [] api_token: [] - summary: Retrieve audit logs for API calls + summary: Retrieve audit logs for Soracom API calls tags: - AuditLog x-soracom-cli: @@ -81,10 +81,10 @@ paths: header: x-soracom-next-key /audit_logs/napter: get: - description: Retrieve audit logs for Napter. + description: Retrieve audit logs for Soracom Napter. operationId: getNapterAuditLogs parameters: - - description: Type of the target resource to query Napter audit log entries. + - description: Type of the target resource to query log entries. in: query name: resource_type required: false @@ -162,7 +162,7 @@ paths: security: - api_key: [] api_token: [] - summary: Retrieve audit logs for Napter + summary: Retrieve audit logs for Soracom Napter tags: - AuditLog x-soracom-cli: @@ -327,7 +327,7 @@ paths: description: | Gets a list of finalized past billing history. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBillingHistory responses: "200": @@ -359,9 +359,9 @@ paths: /bills/{yyyyMM}: get: description: | - Gets a finalized past billing history for the specified month. + Gets a finalized past billing history for the specified month. If you specify current month (the month in which the usage fee has not yet been finalized), you will get the preliminary value. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBilling parameters: - description: Target year and month @@ -399,9 +399,9 @@ paths: /bills/{yyyyMM}/daily: get: description: | - Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. + Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. If you specify current month (a month for which the fee has not yet been finalized), a preliminary value will be returned. - **Warning**: The maximum billing history you can get is for the last 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getBillingPerDay parameters: - description: Target year and month @@ -438,9 +438,9 @@ paths: /bills/{yyyyMM}/export: post: description: | - Issues a URL to download the billing details CSV for the specified month. For more information on billing details CSV, please refer to [Understanding the CSV format](/en/docs/account/billing/#understanding-the-csv-format). + Export historical [Detailed billing CSV](/en/docs/account/billing/#detailed-billing-csv) to dedicated storage and issue URL to download. - **Warning**: You can only download billing details CSV for the past 18 months. If you need the billing history before that time, please contact [Soracom Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: exportBilling parameters: - description: Target year and month @@ -482,17 +482,15 @@ paths: security: - api_key: [] api_token: [] - summary: Issues a URL to download the billing details CSV for the specified - month + summary: Export historical Detailed billing CSV to dedicated storage tags: - Billing x-soracom-cli: - bills export /bills/latest: get: - description: Returns the latest billing amounts after applying discounts such - as free tiers, etc. The amount retrieved by this API is the amount before - the billing is finalized. + description: Retrieves the preliminary usage fee for the current month (the + month in which the usage fee has not yet been finalized). operationId: getLatestBilling responses: "200": @@ -511,13 +509,18 @@ paths: - bills get-latest /bills/latest/export: post: - description: Returns detailed information of the billing amounts for the latest - month. This detailed information includes billing amounts per day, subscriber, - and billing item. The amount retrieved by this API is the amount before the - billing is finalized. + description: Export [Detailed Billing CSV](/en/docs/account/billing/#detailed-billing-csv) + for current month (the month in which the usage fee has not yet been finalized) + to dedicated storage and issue a URL to download it. The fees will be finalized + by the second business day of the following month. The Detailed billing CSV + exported using this API will output preliminary values. operationId: exportLatestBilling parameters: - - description: export_mode (async, sync) + - description: | + Specify how to get the URL to download the billing details CSV. + + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the SORACOM platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`. + - `sync` (default): Wait for the URL to be issued on the SORACOM platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. in: query name: export_mode required: false @@ -552,44 +555,14 @@ paths: /bills/summaries/bill_items: get: description: | - Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + + The summary you can get from this API is equivalent to the usage fees displayed in the [COSTS BY SERVICE] panel of the Billing Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/). operationId: getBillingSummaryOfBillItems responses: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - - amount: 0.09 - billItemCategory: Beam - billItemName: soracomBeamRequestCharge-inHttp - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - amount: 1.8 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfBillItems' @@ -606,39 +579,14 @@ paths: /bills/summaries/sims: get: description: | - Get a billing summary of SIMs for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest. + Get a billing summary of SIMs for the last 4 months (current month to 3 months ago). Sorted by date from newest to oldest. + + The summary you get from this API is equivalent to the rates displayed in the [COSTS PER SIM (TOP 100)] panel of the Rates Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/). operationId: getBillingSummaryOfSims responses: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - simId: "1234567890123456780" - - amount: 0.12 - simId: "1234567890123456781" - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - - amount: 1.8 - simId: "1234567890123456780" - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfSims' @@ -647,7 +595,7 @@ paths: security: - api_key: [] api_token: [] - summary: Gets a billing summary of SIMs. + summary: Gets a billing summary of SIMs tags: - Billing x-soracom-cli: @@ -655,13 +603,10 @@ paths: /cell_locations: get: description: | - Retrieves location information (latitude / longitude) for a cell - tower which is identified by Cell ID etc. Please specify MCC, MNC, LAC - and CID when the access radio technology is 3G. It is possible to retrieve - location information without CID, but the location information will be low - accuracy. For LTE (4G), please specify MCC, MNC, TAC and ECID. As it is based on - an open database to convert cell information into location information, the - location information does not exist or might be incorrect. + Retrieves location information (latitude / longitude) for a cell tower which is identified by Cell ID etc. + Please specify MCC, MNC, LAC and CID when the access radio technology is 3G. It is possible to retrieve location information without CID, but the location information will be low accuracy. + For LTE (4G), please specify MCC, MNC, TAC and ECID. + As it is based on an open database to convert cell information into location information, the location information does not exist or might be incorrect. 3G example. ``` @@ -669,6 +614,7 @@ paths: -H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \ -H "X-Soracom-Token: $X_SORACOM_TOKEN" ``` + 4G example. ``` $ curl -X GET 'https://api.soracom.io/v1/cell_locations?mcc=440&mnc=10&tac=5840&ecid=44668480' \ @@ -677,49 +623,51 @@ paths: ``` operationId: getCellLocation parameters: - - description: MCC - Mobile Country Code + - description: MCC - Mobile Country Code. example: 440 in: query name: mcc required: true schema: type: string - - description: MNC - Mobile Network Code + - description: MNC - Mobile Network Code. example: 10 in: query name: mnc required: true schema: type: string - - description: LAC - Location Area Code (for 3G) + - description: LAC - Location Area Code (for 3G). example: 195 in: query name: lac required: false schema: type: string - - description: CID - Cell ID (for 3G) + - description: CID - Cell ID (for 3G). example: 68485165 in: query name: cid required: false schema: type: string - - description: TAC - Tracking Area Code (for 4G) + - description: TAC - Tracking Area Code (for 4G). example: 5840 in: query name: tac required: false schema: type: string - - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci` + - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. + The result is the same regardless of which value is specified. example: 44668480 in: query name: ecid required: false schema: type: string - - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci` + - description: ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. + The result is the same regardless of which value is specified. example: 44668480 in: query name: eci @@ -741,20 +689,25 @@ paths: updated: 2022-01-01T00:00:00:000Z schema: $ref: '#/components/schemas/CellLocation' - description: Location information for the cell tower + description: Location information for the cell tower. "404": - description: Location information is not found for the cell tower + description: Location information is not found for the cell tower. security: - api_key: [] api_token: [] - summary: Get location information for a cell tower. + summary: Get location information for a cell tower tags: - CellLocation x-soracom-cli: - cell-locations get post: description: Retrieves a list of location information (latitude / longitude) - for multiple cell towers which are identified by Cell IDs etc. + for multiple cell towers which are identified by Cell IDs etc. Please specify + MCC, MNC, LAC and CID when the access radio technology is 3G. It is possible + to retrieve location information without CID, but the location information + will be low accuracy. For LTE (4G), please specify MCC, MNC, TAC and ECID. + As it is based on an open database to convert cell information into location + information, the location information does not exist or might be incorrect. operationId: batchGetCellLocations requestBody: content: @@ -803,7 +756,7 @@ paths: items: $ref: '#/components/schemas/CellLocation' type: array - description: List of location information for the specified cell towers + description: List of location information for the specified cell towers. security: - api_key: [] api_token: [] @@ -832,7 +785,7 @@ paths: x-soracom-cli: - coupons list post: - description: Creates a new coupon quotation. If the orderId is put in /confirm, + description: Creates a new coupon quotation. If the orderId is put in /coupons/{order_id}/confirm, the order is complete. operationId: createCouponQuotation requestBody: @@ -840,7 +793,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEstimatedCouponRequest' - description: Coupon details + description: Coupon details. required: true responses: "201": @@ -848,11 +801,11 @@ paths: application/json: schema: $ref: '#/components/schemas/EstimatedCouponModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create coupon quotation. + summary: Create coupon quotation tags: - Order x-soracom-cli: @@ -862,7 +815,7 @@ paths: description: Registers a coupon. operationId: registerCoupon parameters: - - description: Coupon code + - description: Coupon code. in: path name: coupon_code required: true @@ -881,7 +834,7 @@ paths: security: - api_key: [] api_token: [] - summary: Register Coupon. + summary: Register Coupon tags: - Payment x-soracom-cli: @@ -908,14 +861,14 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm coupon order. + summary: Confirm coupon order tags: - Order x-soracom-cli: - coupons confirm /credentials: get: - description: Returns a list of credentials. + description: Returns a list of credentials set. operationId: listCredentials responses: "200": @@ -929,17 +882,17 @@ paths: security: - api_key: [] api_token: [] - summary: List of credentials. + summary: List of credentials set tags: - Credential x-soracom-cli: - credentials list /credentials/{credentials_id}: delete: - description: Deletes a credential. + description: Deletes a credentials set. operationId: deleteCredential parameters: - - description: Credentials ID + - description: Credentials set ID. in: path name: credentials_id required: true @@ -947,22 +900,22 @@ paths: type: string responses: "204": - description: Deleted + description: Credentials set has been deleted. "404": - description: Not Found + description: Not Found. security: - api_key: [] api_token: [] - summary: Delete a credential. + summary: Delete a credentials set tags: - Credential x-soracom-cli: - credentials delete post: - description: Creates a new credential. + description: Creates a new credentials set. operationId: createCredential parameters: - - description: credentials_id + - description: Credentials set ID. in: path name: credentials_id required: true @@ -1016,7 +969,7 @@ paths: $ref: '#/components/examples/MockmockDatarecorderCredentials' schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true responses: "201": @@ -1024,20 +977,20 @@ paths: application/json: schema: $ref: '#/components/schemas/CredentialsModel' - description: Created + description: Credentials set has been created. security: - api_key: [] api_token: [] - summary: Create a credential. + summary: Create a credentials set tags: - Credential x-soracom-cli: - credentials create put: - description: Updates a credential. + description: Updates a credentials set. operationId: updateCredential parameters: - - description: credentials_id + - description: Credentials set ID. in: path name: credentials_id required: true @@ -1048,7 +1001,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true responses: "200": @@ -1064,7 +1017,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update a credential. + summary: Update a credentials set tags: - Credential x-soracom-cli: @@ -1125,11 +1078,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: Key in the last data entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the @@ -2058,11 +2014,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -2298,7 +2257,7 @@ paths: description: Returns a list of event handlers. operationId: listEventHandlers parameters: - - description: target + - description: The event handler target (the target for executing events). in: query name: target required: false @@ -2321,20 +2280,20 @@ paths: security: - api_key: [] api_token: [] - summary: List Event Handlers. + summary: List Event Handlers tags: - EventHandler x-soracom-cli: - event-handlers list post: - description: Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/ + description: Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/. operationId: createEventHandler requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEventHandlerRequest' - description: event handler settings + description: Event handler settings. required: true responses: "201": @@ -2342,11 +2301,11 @@ paths: application/json: schema: $ref: '#/components/schemas/EventHandlerModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Event Handler. + summary: Create Event Handler tags: - EventHandler x-soracom-cli: @@ -2356,7 +2315,7 @@ paths: description: Deletes the specified event handler. operationId: deleteEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2366,11 +2325,11 @@ paths: "204": description: OK. "404": - description: EventHandler not found. + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Delete Event Handler. + summary: Delete Event Handler tags: - EventHandler x-soracom-cli: @@ -2379,7 +2338,7 @@ paths: description: Returns information about the specified event handler. operationId: getEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2393,20 +2352,20 @@ paths: $ref: '#/components/schemas/EventHandlerModel' description: OK. "404": - description: Handler not found. + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Get Event Handler. + summary: Get Event Handler tags: - EventHandler x-soracom-cli: - event-handlers get put: - description: Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/ + description: Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/. operationId: updateEventHandler parameters: - - description: handler ID + - description: Event handler ID. in: path name: handler_id required: true @@ -2417,17 +2376,17 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateEventHandlerRequest' - description: event handler settings + description: Event handler settings. required: true responses: "200": description: OK. "400": - description: Invalid handlerId. + description: Invalid event handler ID. security: - api_key: [] api_token: [] - summary: Update Event Handler. + summary: Update Event Handler tags: - EventHandler x-soracom-cli: @@ -2438,13 +2397,13 @@ paths: the specified IMSI. operationId: deleteIgnoreEventHandler parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true schema: type: string - - description: handler_id + - description: Event handler ID. in: path name: handler_id required: true @@ -2452,13 +2411,13 @@ paths: type: string responses: "204": - description: OK + description: OK. "404": - description: not found + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: Delete Ignore Event Handler. + summary: Delete Ignore Event Handler tags: - EventHandler x-soracom-cli: @@ -2468,13 +2427,13 @@ paths: specified IMSI. operationId: setIgnoreEventHandler parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true schema: type: string - - description: handler_id + - description: Event handler ID. in: path name: handler_id required: true @@ -2482,11 +2441,11 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Ignore Event Handler. + summary: Ignore Event Handler tags: - EventHandler x-soracom-cli: @@ -2496,7 +2455,7 @@ paths: description: Returns a list of event handlers related to the specified IMSI. operationId: listEventHandlersBySubscriber parameters: - - description: imsi + - description: IMSI. in: path name: imsi required: true @@ -2512,11 +2471,11 @@ paths: type: array description: OK. "404": - description: not found + description: Event Handler not found. security: - api_key: [] api_token: [] - summary: List Event Handlers related to Subscriber. + summary: List Event Handlers related to Subscriber tags: - EventHandler x-soracom-cli: @@ -2680,11 +2639,20 @@ paths: type: string responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FileEntry' description: Metadata of the file + headers: + Content-Length: + description: File size (bytes) + schema: + type: integer + Content-Type: + description: File's Content-Type + schema: + type: string + ETag: + description: Identifier representing the file version + schema: + type: string "404": description: No such file. security: @@ -2883,12 +2851,15 @@ paths: - files get-exported /gadgets: get: - description: Returns a list of gadgets that match certain criteria. If the total - number of gadgets does not fit in one page, a URL for accessing the next page - is returned in the 'Link' header of the response. + description: | + Returns a list of gadgets that match certain criteria. If the total number of gadgets does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listGadgets parameters: - - description: Product ID for filtering the search. + - description: | + Product ID of the target Gadget API compatible device for filtering the search. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: query name: product_id required: false @@ -2897,20 +2868,25 @@ paths: - button - wimax type: string - - description: Tag name for filtering the search (exact match). + - description: Tag name for filtering the search. The search is always an exact + match, regardless of the setting of `tag_value_match_mode`. in: query name: tag_name required: false schema: type: string - - description: Tag search string for filtering the search. Required when `tag_name` - has been specified. + - description: Specifies a tag value to search for in a URL-encoded (percent-encoded) + string. Required when `tag_name` has been specified. in: query name: tag_value required: false schema: type: string - - description: Tag match mode. + - description: | + Tag match mode. + + - `exact`: exact match. + - `prefix`: prefix match. in: query name: tag_value_match_mode required: false @@ -2920,15 +2896,18 @@ paths: - exact - prefix type: string - - description: Maximum number of gadgets to retrieve. + - description: Maximum number of Gadget API compatible devices data to retrieve. in: query name: limit required: false schema: type: integer - - description: The ID ({product_id}/{serial_number}) of the last gadget retrieved - on the current page. By specifying this parameter, you can continue to retrieve - the list from the next device onward. + - description: | + The ID (`{product_id}/{serial_number}`) of the last gadget retrieved on the previous page in URL encoding (percent encoding). + + By specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward. + + The value of the `last_evaluated_key` of `rel=next` returned in the `link` header when the API is called is expected to be specified in the next call, but any ID (`{productId}/{serialNumber}`) can be specified. in: query name: last_evaluated_key required: false @@ -2963,11 +2942,11 @@ paths: items: $ref: '#/components/schemas/Gadget' type: array - description: A list of Gadgets. + description: A list of Gadget API compatible devices. security: - api_key: [] api_token: [] - summary: List gadgets. + summary: List gadgets tags: - Gadget x-soracom-cli: @@ -2979,10 +2958,14 @@ paths: header: x-soracom-next-key /gadgets/{product_id}/{serial_number}: get: - description: Returns information about the specified gadget. + description: Returns information about the specified Gadget API compatible device. operationId: getGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -2991,7 +2974,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3024,23 +3007,28 @@ paths: terminationEnabled: false schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information. + description: Detailed information about the specified Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Get gadget. + summary: Get Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets get /gadgets/{product_id}/{serial_number}/disable_termination: post: - description: Disables termination of specified gadget. + description: Disables termination of specified Gadget API compatible device. operationId: disableTerminationOnGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3049,7 +3037,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3061,23 +3049,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Disable Termination of gadget. + summary: Disables Termination of Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets disable-termination /gadgets/{product_id}/{serial_number}/enable_termination: post: - description: Enables termination of specified gadget. + description: Enables termination of specified Gadget API compatible device. operationId: enableTerminationOnGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3086,7 +3079,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3098,23 +3091,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Enable Termination of gadget. + summary: Enables Termination of Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets enable-termination /gadgets/{product_id}/{serial_number}/register: post: - description: Registers a gadget + description: Registers a Gadget API compatible device. operationId: registerGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3123,7 +3121,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3134,7 +3132,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GadgetRegistrationRequest' - description: Gadget registration request + description: Gadget registration request. required: true responses: "200": @@ -3142,23 +3140,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: Gadget successfully registered + description: Gadget API compatible device successfully registered. "404": description: No such resource found. security: - api_key: [] api_token: [] - summary: Register a gadget. + summary: Registers a Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets register /gadgets/{product_id}/{serial_number}/tags: put: - description: Inserts/updates tags for the specified gadget. + description: Inserts/updates tags for the specified Gadget API compatible device. operationId: putGadgetTags parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3167,7 +3169,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3188,23 +3190,28 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update gadget Tags. + summary: Bulk Insert or Update Gadget API compatible device tags tags: - Gadget x-soracom-cli: - gadgets put-tags /gadgets/{product_id}/{serial_number}/tags/{tag_name}: delete: - description: Deletes a tag from the specified gadget. + description: Deletes a tag from the specified Gadget API compatible device. operationId: deleteGadgetTag parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3213,7 +3220,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3231,11 +3238,12 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified gadget or the tag does not exist. + description: The specified Gadget API compatible devices or the tags does + not exist. security: - api_key: [] api_token: [] - summary: Delete gadget Tag. + summary: Deletes tags from Gadget API compatible device tags: - Gadget x-sam-operationId: deleteTag @@ -3243,10 +3251,14 @@ paths: - gadgets delete-tag /gadgets/{product_id}/{serial_number}/terminate: post: - description: Terminates the specified gadget + description: Terminates the specified Gadget API compatible device. operationId: terminateGadget parameters: - - description: Product ID of the target gadget. + - description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. in: path name: product_id required: true @@ -3255,7 +3267,7 @@ paths: - button - wimax type: string - - description: Serial Number of the target gadget. + - description: Serial Number of the target Gadget API compatible device. in: path name: serial_number required: true @@ -3267,20 +3279,21 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: The gadget's detailed information after the update. + description: Detailed information about the updated Gadget API compatible + device. "404": - description: The specified gadget does not exist. + description: The specified Gadget API compatible device does not exist. security: - api_key: [] api_token: [] - summary: Terminate gadget. + summary: Terminates the specified Gadget API compatible device tags: - Gadget x-soracom-cli: - gadgets terminate /groups: get: - description: Returns a list of groups. + description: Returns a list of Groups. operationId: listGroups parameters: - description: Tag name of the group. Filters through all groups that exactly @@ -3296,7 +3309,7 @@ paths: required: false schema: type: string - - description: Tag match mode. + - description: Search criteria for tag strings (`tag_value`). in: query name: tag_value_match_mode required: false @@ -3348,31 +3361,59 @@ paths: requestBody: content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + tags: + name: Group name schema: $ref: '#/components/schemas/CreateGroupRequest' - description: Tags for group to be created. + description: Tags and configuration for a new group to be created. required: true responses: "201": content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + createdAt: 1698796800000 + createdTime: 1698796800000 + groupId: 12345678-abcd-9012-efab-345678901234 + lastModifiedAt: 1698796800000 + lastModifiedTime: 1698796800000 + operatorId: OP0012345678 + tags: + name: Group name schema: $ref: '#/components/schemas/Group' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Group. + summary: Create Group tags: - Group x-soracom-cli: - groups create /groups/{group_id}: delete: - description: Deletes the specified group by group ID + description: Deletes the group specified by Group ID. operationId: deleteGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3386,7 +3427,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group. + summary: Delete Group tags: - Group x-soracom-cli: @@ -3395,7 +3436,7 @@ paths: description: Returns the group specified by the group ID. operationId: getGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3407,13 +3448,13 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: The specified group. + description: Specified Group. "404": description: The specified group does not exist. security: - api_key: [] api_token: [] - summary: Get Group. + summary: Get Group tags: - Group x-soracom-cli: @@ -3423,7 +3464,7 @@ paths: description: Delete a namespace for the specified group. operationId: deleteConfigurationNamespace parameters: - - description: Target group. + - description: ID of the target Group. in: path name: group_id required: true @@ -3438,6 +3479,7 @@ paths: - SoracomAir - SoracomBeam - SoracomEndorse + - SoracomOrbit - SoracomFunk - SoracomFunnel - SoracomHarvest @@ -3455,7 +3497,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group Configuration Namespace. + summary: Delete Group Configuration Namespace tags: - Group x-soracom-cli: @@ -3464,7 +3506,8 @@ paths: description: Adds/updates parameters for the specified group. operationId: putConfigurationParameters parameters: - - description: Target group. + - description: ID of the target Group. It can be obtained via [`Group:listGroups + API`](#/Group/listGroups). in: path name: group_id required: true @@ -3545,7 +3588,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Group Configuration Parameters. + summary: Update Group Configuration Parameters tags: - Group x-soracom-cli: @@ -3555,7 +3598,7 @@ paths: description: Delete parameters for the specified group. operationId: deleteConfigurationParameter parameters: - - description: Target group. + - description: ID of the target Group. in: path name: group_id required: true @@ -3593,7 +3636,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Group Configuration Parameters. + summary: Delete Group Configuration Parameters tags: - Group x-soracom-cli: @@ -3604,7 +3647,7 @@ paths: by group ID. operationId: listSubscribersInGroup parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3629,14 +3672,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Group' - description: Target group ID + items: + $ref: '#/components/schemas/Sim' + type: array + description: Specified Group. "404": description: The specified group does not exist. security: - api_key: [] api_token: [] - summary: List Subscribers in a group. + summary: List Subscribers in a group tags: - Group x-sam-operationId: listSubscribers @@ -3652,7 +3697,7 @@ paths: description: Adds/updates tags of specified configuration group. operationId: putGroupTags parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3679,7 +3724,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Group Tags. + summary: Update Group Tags tags: - Group x-sam-operationId: putTags @@ -3690,7 +3735,7 @@ paths: description: Deletes tag from the specified group. operationId: deleteGroupTag parameters: - - description: Target group ID. + - description: ID of the target Group. in: path name: group_id required: true @@ -3708,11 +3753,11 @@ paths: "204": description: Tag deletion complete. "404": - description: The specified subscriber or the tag does not exist. + description: The specified group or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete Group Tag. + summary: Delete Group Tag tags: - Group x-sam-operationId: deleteTag @@ -3721,12 +3766,12 @@ paths: /lagoon/dashboards/{dashboard_id}/permissions: put: description: | - Update permissions for a SORACOM Lagoon 2 dashboard. + Update permissions for a Soracom Lagoon 2 dashboard. - **Warning**: A SORACOM Lagoon 3 dashboard cannot be updated with this API. + **Warning**: A Soracom Lagoon 3 dashboard cannot be updated with this API. operationId: updateLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: ID of the target Dashboard. in: path name: dashboard_id required: true @@ -3746,19 +3791,19 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonDashboardPermissionsUpdatingRequest' - description: req + description: Request. required: true responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "403": - description: Unauthorized operation + description: Unauthorized operation. security: - api_key: [] api_token: [] - summary: Update permissions for a SORACOM Lagoon 2 dashboard + summary: Update permissions for a Soracom Lagoon 2 dashboard tags: - Lagoon x-soracom-cli: @@ -3766,20 +3811,21 @@ paths: /lagoon/dashboards/{dashboard_id}/permissions/init: post: description: | - Update permissions to the initial state for a SORACOM Lagoon 2 dashboard. + Update permissions to the initial state for a Soracom Lagoon 2 dashboard. - **Warning**: This API cannot update permissions for a SORACOM Lagoon 3 dashboard. + **Warning**: This API cannot update permissions for a Soracom Lagoon 3 dashboard. operationId: initializeLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: ID of the target Dashboard. in: path name: dashboard_id required: true schema: format: int64 type: integer - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3787,26 +3833,30 @@ paths: type: boolean responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "403": - description: Unauthorized operation + description: Unauthorized operation. security: - api_key: [] api_token: [] - summary: Update permissions to the initial state for a SORACOM Lagoon 2 dashboard + summary: Update permissions to the initial state for a Soracom Lagoon 2 dashboard tags: - Lagoon x-soracom-cli: - lagoon dashboards init-permissions /lagoon/dashboards/permissions: get: - description: List permissions for all SORACOM Lagoon 2 dashboards + description: | + List permissions for all Soracom Lagoon 2 dashboards. + + **Warning**: This API cannot obtain Dashboard permissions for Soracom Lagoon 3. operationId: listLagoonDashboardsPermissions parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3820,24 +3870,25 @@ paths: items: $ref: '#/components/schemas/LagoonDashboardPermissionsResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: List permissions for all SORACOM Lagoon 2 dashboards + summary: List permissions for all Soracom Lagoon 2 dashboards tags: - Lagoon x-soracom-cli: - lagoon dashboards list-permissions /lagoon/image/link: get: - description: Get a custom icon image link of SORACOM Lagoon Console + description: Get a custom icon image link of Soracom Lagoon Console. operationId: getImageLink parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -3849,20 +3900,20 @@ paths: application/json: schema: type: string - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get a custom icon image link of SORACOM Lagoon Console + summary: Get a custom icon image link of Soracom Lagoon Console tags: - Lagoon x-soracom-cli: - lagoon get-image-link /lagoon/license_packs: get: - description: Get the status of active SORACOM Lagoon license packs + description: Get the status of active Soracom Lagoon license packs. operationId: listLagoonLicensePackStatus responses: "200": @@ -3872,65 +3923,65 @@ paths: items: $ref: '#/components/schemas/LagoonLicensePackStatusResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get the status of active SORACOM Lagoon license packs + summary: Get the status of active Soracom Lagoon license packs tags: - Lagoon x-soracom-cli: - lagoon license-packs list-status put: description: | - Update the quantities for license packs of SORACOM Lagoon. + Update the quantities for license packs of Soracom Lagoon. - **Warning**: This API must be called with the root user credentials. The quantities for license packs of SORACOM Lagoon cannot be updated with SAM user credentials. + **Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials. operationId: updateLagoonLicensePack requestBody: content: application/json: schema: $ref: '#/components/schemas/LagoonLicensePacksUpdatingRequest' - description: req + description: Request. required: true responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "404": - description: Operator Not Found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Update the quantities for license packs of SORACOM Lagoon + summary: Update the quantities for license packs of Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon license-packs update /lagoon/migration: get: - description: Get the version migration information for SORACOM Lagoon. Only + description: Get the version migration information for Soracom Lagoon. Only the root account can operate this. operationId: getLagoonMigrationInfo requestBody: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "200": - description: OK. The response body contains the Lagoon migration information. + description: The response body contains the Lagoon migration information. security: - api_key: [] api_token: [] - summary: Get the version migration information for SORACOM Lagoon + summary: Get the version migration information for Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon migration get-info post: - description: Migrate SORACOM Lagoon version. Only the root account can operate + description: Migrate Soracom Lagoon version. Only the root account can operate this. operationId: migrateLagoon requestBody: @@ -3938,15 +3989,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonMigrationRequest' - description: req + description: Request. required: true responses: "200": - description: OK. It has finished the Lagoon migration. + description: It has finished the Lagoon migration. security: - api_key: [] api_token: [] - summary: Migrate SORACOM Lagoon version + summary: Migrate Soracom Lagoon version tags: - Lagoon x-soracom-cli: @@ -3954,7 +4005,7 @@ paths: /lagoon/plan: put: description: | - Update the plan of SORACOM Lagoon. + Update the plan of Soracom Lagoon. **Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials. operationId: updateLagoonPlan @@ -3962,15 +4013,15 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "204": - description: Updated + description: Updated. "400": - description: Bad request + description: Bad request. "404": - description: Operator Not Found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Update the plan of SORACOM Lagoon + summary: Update the plan of Soracom Lagoon tags: - Lagoon x-soracom-cli: @@ -3978,7 +4029,7 @@ paths: /lagoon/register: post: description: | - Register (activate) SORACOM Lagoon. + Register (activate) Soracom Lagoon. **Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials. operationId: registerLagoon @@ -3987,7 +4038,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationRequest' - description: request + description: Request. required: true responses: "201": @@ -3995,13 +4046,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationResponse' - description: Registered + description: Registered. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Register (activate) SORACOM Lagoon + summary: Register (activate) Soracom Lagoon tags: - Lagoon x-soracom-cli: @@ -4009,32 +4060,33 @@ paths: /lagoon/terminate: post: description: | - Terminate (deactivate) SORACOM Lagoon. + Terminate (deactivate) Soracom Lagoon. **Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials. operationId: terminateLagoon responses: "204": - description: Terminated + description: Terminated. "400": - description: Bad request + description: Bad request. "404": - description: Operator not found + description: Operator not found. security: - api_key: [] api_token: [] - summary: Terminate (deactivate) SORACOM Lagoon + summary: Terminate (deactivate) Soracom Lagoon tags: - Lagoon x-soracom-cli: - lagoon terminate /lagoon/users: get: - description: List SORACOM Lagoon users that belong to operator. + description: List Soracom Lagoon users that belong to operator. operationId: listLagoonUsers parameters: - - description: If the value is true, a request will be issued to Lagoon 2. This - is only valid if both Lagoon 3 and Lagoon 2 are enabled. + - description: | + If the value is true, a request will be issued to Lagoon 2. + This is only valid if both Lagoon 3 and Lagoon 2 are enabled. in: query name: v2 required: false @@ -4048,27 +4100,27 @@ paths: items: $ref: '#/components/schemas/LagoonUser' type: array - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: List SORACOM Lagoon users that belong to operator + summary: List Soracom Lagoon users that belong to operator tags: - Lagoon x-soracom-cli: - lagoon list-users - lagoon users list post: - description: Create a SORACOM Lagoon user. + description: Create a Soracom Lagoon user. operationId: createLagoonUser requestBody: content: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationRequest' - description: request + description: Request. required: true responses: "201": @@ -4076,13 +4128,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationResponse' - description: Created + description: Created. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Create a SORACOM Lagoon user + summary: Create a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4090,10 +4142,10 @@ paths: - lagoon users create /lagoon/users/{lagoon_user_id}: delete: - description: Delete a SORACOM Lagoon user. + description: Delete a Soracom Lagoon user. operationId: deleteLagoonUser parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4101,13 +4153,13 @@ paths: type: integer responses: "204": - description: Deleted + description: Deleted. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Delete a SORACOM Lagoon user + summary: Delete a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4115,10 +4167,10 @@ paths: - lagoon users delete /lagoon/users/{lagoon_user_id}/email: put: - description: Update email address of a SORACOM Lagoon user. + description: Update email address of a Soracom Lagoon user. operationId: updateLagoonUserEmail parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4129,17 +4181,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserEmailUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update email address of a SORACOM Lagoon user + summary: Update email address of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4147,10 +4199,10 @@ paths: - lagoon users update-email /lagoon/users/{lagoon_user_id}/password: put: - description: Update password of a SORACOM Lagoon user. + description: Update password of a Soracom Lagoon user. operationId: updateLagoonUserPassword parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4161,17 +4213,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPasswordUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update password of a SORACOM Lagoon user + summary: Update password of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4179,10 +4231,10 @@ paths: - lagoon users update-password /lagoon/users/{lagoon_user_id}/permission: put: - description: Update permission of a SORACOM Lagoon user. + description: Update permission of a Soracom Lagoon user. operationId: updateLagoonUserPermission parameters: - - description: Target ID of the lagoon user + - description: Target ID of the lagoon user. in: path name: lagoon_user_id required: true @@ -4193,17 +4245,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPermissionUpdatingRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Update permission of a SORACOM Lagoon user + summary: Update permission of a Soracom Lagoon user tags: - Lagoon x-soracom-cli: @@ -4211,9 +4263,8 @@ paths: - lagoon users update-permission /logs: get: - description: Returns a list of log entries that match certain criteria. If the - total number of entries does not fit in one page, a URL for accessing the - next page is returned in the 'Link' header of the response. + description: | + Returns a list of log entries that match certain criteria. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: getLogs parameters: - description: Type of the target resource to query log entries. @@ -4247,13 +4298,13 @@ paths: - Funnel - Gate type: string - - description: Start time for the log search range (unixtime). + - description: Start time for the log search range (UNIX time in milliseconds). in: query name: from required: false schema: type: integer - - description: End time for the log search range (unixtime). + - description: End time for the log search range (UNIX time in milliseconds). in: query name: to required: false @@ -4285,7 +4336,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Logs. + summary: Get Logs tags: - Log x-soracom-cli: @@ -4423,11 +4474,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -4756,9 +4810,8 @@ paths: - lora-devices unset-group /lora_gateways: get: - description: Returns a list of LoRa gateways that match certain criteria. If - the total number of LoRa gateways does not fit in one page, a URL for accessing - the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN gateways that match certain criteria. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listLoraGateways parameters: - description: Tag name for filtering the search (exact match). @@ -4784,16 +4837,16 @@ paths: - exact - prefix type: string - - description: Maximum number of LoRa devices to retrieve. + - description: Maximum number of LoRaWAN gateways to retrieve. in: query name: limit required: false schema: format: int32d type: integer - - description: The device ID of the last device retrieved on the current page. - By specifying this parameter, you can continue to retrieve the list from - the next device onward. + - description: The Gateway ID of the last LoRaWAN gateway retrieved on the current + page. By specifying this parameter, you can continue to retrieve the list + from the next LoRaWAN gateway onward. in: query name: last_evaluated_key required: false @@ -4807,11 +4860,11 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: A list of LoRa gateways. + description: A list of LoRaWAN gateways. security: - api_key: [] api_token: [] - summary: List LoRa Gateways. + summary: List LoRaWAN Gateways tags: - LoraGateway x-soracom-cli: @@ -4823,10 +4876,10 @@ paths: header: x-soracom-next-key /lora_gateways/{gateway_id}: get: - description: Returns information about the specified LoRa gateway. + description: Returns information about the specified LoRaWAN gateway. operationId: getLoraGateway parameters: - - description: Gateway ID of the target LoRa gateway. + - description: Gateway ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4838,23 +4891,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information. + description: The LoRaWAN gateway's detailed information. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Get LoRa gateway. + summary: Get LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways get /lora_gateways/{gateway_id}/disable_termination: post: - description: Disables termination of specified LoRa gateway. + description: Disables termination of specified LoRaWAN gateway. operationId: disableTerminationOnLoraGateway parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4866,23 +4919,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Disable Termination of LoRa gateway. + summary: Disable Termination of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways disable-termination /lora_gateways/{gateway_id}/enable_termination: post: - description: Enables termination of specified LoRa gateway. + description: Enables termination of specified LoRaWAN gateway. operationId: enableTerminationOnLoraGateway parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4894,23 +4947,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Enable Termination of LoRa gateway. + summary: Enable Termination of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways enable-termination /lora_gateways/{gateway_id}/set_network_set: post: - description: Sets or overwrites network set ID for the specified LoRa gateway. + description: Sets or overwrites network set ID for the specified LoRaWAN gateway. operationId: setLoraNetworkSet parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4921,30 +4974,30 @@ paths: text/plain: schema: $ref: '#/components/schemas/SetNetworkSetRequest' - description: LoRa Network Set ID. + description: LoRaWAN Network Set ID. responses: "200": content: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa device does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Set Network Set ID of LoRa gateway. + summary: Set Network Set ID of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways set-network-set /lora_gateways/{gateway_id}/tags: put: - description: Inserts/updates tags for the specified LoRa gateway. + description: Inserts/updates tags for the specified LoRaWAN gateway. operationId: putLoraGatewayTags parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -4965,31 +5018,31 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update LoRa gateway Tags. + summary: Bulk Insert or Update LoRaWAN gateway Tags tags: - LoraGateway x-soracom-cli: - lora-gateways put-tags /lora_gateways/{gateway_id}/tags/{tag_name}: delete: - description: Deletes a tag from the specified LoRa gateway. + description: Deletes a tag from the specified LoRaWAN gateway. operationId: deleteLoraGatewayTag parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true schema: type: string - - description: Name of tag to be deleted. (This will be part of a URL path, - so it needs to be percent-encoded. In JavaScript, specify the name after - it has been encoded using encodeURIComponent().) + - description: Tag name to be deleted. (This will be part of a URL path, so + it needs to be percent-encoded. In JavaScript, specify the name after it + has been encoded using encodeURIComponent().) in: path name: tag_name required: true @@ -4999,21 +5052,21 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified LoRa gateway or the tag does not exist. + description: The specified LoRaWAN gateway or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa gateway tag. + summary: Delete LoRaWAN gateway tag tags: - LoraGateway x-soracom-cli: - lora-gateways delete-tag /lora_gateways/{gateway_id}/terminate: post: - description: Terminates the specified LoRa gateway + description: Terminates the specified LoRaWAN gateway. operationId: terminateLoraGateway parameters: - - description: Device ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -5025,23 +5078,23 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Terminate LoRa gateway. + summary: Terminate LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways terminate /lora_gateways/{gateway_id}/unset_network_set: post: - description: Unset network set ID of the specified LoRa gateway. + description: Unset network set ID of the specified LoRaWAN gateway. operationId: unsetLoraNetworkSet parameters: - - description: ID of the target LoRa gateway. + - description: ID of the target LoRaWAN gateway. in: path name: gateway_id required: true @@ -5053,22 +5106,21 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: The LoRa gateway's detailed information after the update. + description: The LoRaWAN gateway's detailed information after the update. "404": - description: The specified LoRa gateway does not exist. + description: The specified LoRaWAN gateway does not exist. security: - api_key: [] api_token: [] - summary: Unset Network Set ID of LoRa gateway. + summary: Unset Network Set ID of LoRaWAN gateway tags: - LoraGateway x-soracom-cli: - lora-gateways unset-network-set /lora_network_sets: get: - description: Returns a list of LoRa network sets that match certain criteria. - If the total number of LoRa network sets does not fit in one page, a URL for - accessing the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN network sets that match certain criteria. If the total number of LoRaWAN network sets does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listLoraNetworkSets parameters: - description: Tag name for filtering the search (exact match). @@ -5094,7 +5146,7 @@ paths: - exact - prefix type: string - - description: Maximum number of LoRa devices to retrieve. + - description: Maximum number of LoRaWAN network set to retrieve. in: query name: limit required: false @@ -5117,11 +5169,11 @@ paths: items: $ref: '#/components/schemas/LoraNetworkSet' type: array - description: A list of LoRa network sets. + description: A list of LoRaWAN network sets. security: - api_key: [] api_token: [] - summary: List LoRa Network Sets. + summary: List LoRaWAN Network Sets tags: - LoraNetworkSet x-soracom-cli: @@ -5132,14 +5184,15 @@ paths: response: header: x-soracom-next-key post: - description: Creates a specified LoRa network set + description: Creates a specified LoRaWAN network set. operationId: createLoraNetworkSet requestBody: content: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: Additional metadata such as tags for a LoRa network set to create. + description: Additional metadata such as tags for a LoRaWAN network set to + create. required: true responses: "201": @@ -5147,21 +5200,21 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: A LoRa network set was created. + description: A LoRaWAN network set was created. security: - api_key: [] api_token: [] - summary: Create a LoRa network set. + summary: Create a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets create /lora_network_sets/{ns_id}: delete: - description: Deletes the specified LoRa network set + description: Deletes the specified LoRaWAN network set. operationId: deleteLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5171,20 +5224,20 @@ paths: "204": description: Successfully deleted. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa network set. + summary: Delete LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete get: - description: Returns information about the specified LoRa network set. + description: Returns information about the specified LoRaWAN network set. operationId: getLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5196,13 +5249,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: The LoRa network set's detailed information. + description: The LoRaWAN network set's detailed information. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Get LoRa network set. + summary: Get LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: @@ -5212,7 +5265,7 @@ paths: description: Adds permission to allow another operator to use the network set. operationId: addPermissionToLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5235,34 +5288,33 @@ paths: security: - api_key: [] api_token: [] - summary: Adds permission to a LoRa network set. + summary: Adds permission to a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets add-permission /lora_network_sets/{ns_id}/gateways: get: - description: Returns a list of LoRa gateways that belong to the specified network - set. If the total number of LoRa gateways does not fit in one page, a URL - for accessing the next page is returned in the 'Link' header of the response. + description: | + Returns a list of LoRaWAN gateways that belong to the specified network set. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the 'link' header of the response. operationId: listGatewaysInLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true schema: type: string - - description: Maximum number of LoRa gateways to retrieve. + - description: Maximum number of LoRaWAN gateways to retrieve. in: query name: limit required: false schema: format: int32d type: integer - - description: The ID of the last gateway retrieved on the current page. By - specifying this parameter, you can continue to retrieve the list from the - next device onward. + - description: The Gateway ID of the last LoRaWAN gateway retrieved on the current + page. By specifying this parameter, you can continue to retrieve the list + from the next LoRaWAN gateway onward. in: query name: last_evaluated_key required: false @@ -5276,13 +5328,13 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: A list of LoRa gateways. + description: A list of LoRaWAN gateways. "404": - description: The specified network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: List LoRa Gateways in a Network Set. + summary: List LoRaWAN Gateways in a Network Set tags: - LoraNetworkSet x-soracom-cli: @@ -5298,7 +5350,7 @@ paths: operators in the network set. operationId: revokePermissionFromLoraNetworkSet parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5321,17 +5373,17 @@ paths: security: - api_key: [] api_token: [] - summary: Revokes a permission from a LoRa network set. + summary: Revokes a permission from a LoRaWAN network set tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets revoke-permission /lora_network_sets/{ns_id}/tags: put: - description: Inserts/updates tags for the specified LoRa network set. + description: Inserts/updates tags for the specified LoRaWAN network set. operationId: putLoraNetworkSetTags parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true @@ -5352,31 +5404,31 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: The LoRa network set's detailed information after the update. + description: The LoRaWAN network set's detailed information after the update. "404": - description: The specified LoRa network set does not exist. + description: The specified LoRaWAN network set does not exist. security: - api_key: [] api_token: [] - summary: Bulk Insert or Update LoRa network set tags. + summary: Bulk Insert or Update LoRaWAN network set tags tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets put-tag /lora_network_sets/{ns_id}/tags/{tag_name}: delete: - description: Deletes a tag from the specified LoRa network set. + description: Deletes a tag from the specified LoRaWAN network set. operationId: deleteLoraNetworkSetTag parameters: - - description: ID of the target LoRa network set. + - description: ID of the target LoRaWAN network set. in: path name: ns_id required: true schema: type: string - - description: Name of tag to be deleted. (This will be part of a URL path, - so it needs to be percent-encoded. In JavaScript, specify the name after - it has been encoded using encodeURIComponent().) + - description: Tag name to be deleted. (This will be part of a URL path, so + it needs to be percent-encoded. In JavaScript, specify the name after it + has been encoded using encodeURIComponent().) in: path name: tag_name required: true @@ -5386,48 +5438,21 @@ paths: "204": description: Deletion of specified tag complete. "404": - description: The specified LoRa network set or the tag does not exist. + description: The specified LoRaWAN network set or the tag does not exist. security: - api_key: [] api_token: [] - summary: Delete LoRa network set tag. + summary: Delete LoRaWAN network set tag tags: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete-tag - /operators: - post: - description: Makes a request to create a new operator. An e-mail is sent to - the e-mail address specified in the parameters, containing a one-time token - for verifying the operator’s registration. - operationId: createOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterOperatorsRequest' - description: email, password - required: true - responses: - "201": - description: Operator created. - "400": - description: The e-mail address is already registered or the password has - an incorrect format. - security: - - api_key: [] - api_token: [] - summary: Create Operator. - tags: - - Operator - x-soracom-cli: - - operator create /operators/{operator_id}: get: description: Returns information about the operator. operationId: getOperator parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5441,11 +5466,11 @@ paths: $ref: '#/components/schemas/GetOperatorResponse' description: OK. "400": - description: Invalid Operator Id + description: Invalid Operator Id. security: - api_key: [] api_token: [] - summary: Get Operator. + summary: Get Operator tags: - Operator x-soracom-cli: @@ -5455,7 +5480,7 @@ paths: description: Returns the operator's AuthKey list. operationId: listOperatorAuthKeys parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5473,7 +5498,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Operator AuthKeys. + summary: List Operator AuthKeys tags: - Operator x-soracom-cli: @@ -5482,7 +5507,7 @@ paths: description: Generates an AuthKey for the operator. operationId: generateOperatorAuthKey parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5498,7 +5523,7 @@ paths: security: - api_key: [] api_token: [] - summary: Generate Operator AuthKey. + summary: Generate Operator AuthKey tags: - Operator x-soracom-cli: @@ -5508,13 +5533,13 @@ paths: description: Deletes an AuthKey from the operator. operationId: deleteOperatorAuthKey parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: auth_key_id + - description: AuthKey ID. in: path name: auth_key_id required: true @@ -5526,7 +5551,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Operator AuthKey. + summary: Delete Operator AuthKey tags: - Operator x-soracom-cli: @@ -5536,7 +5561,7 @@ paths: description: Gets the operator's company information. operationId: getCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5552,7 +5577,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get company information. + summary: Get company information tags: - Operator x-soracom-cli: @@ -5561,7 +5586,7 @@ paths: description: Creates the operator's company information. operationId: createCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5572,7 +5597,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: Model. required: true responses: "201": @@ -5580,7 +5605,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create company information. + summary: Create company information tags: - Operator x-soracom-cli: @@ -5589,7 +5614,7 @@ paths: description: Updates the operator's company information. operationId: updateCompanyInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5600,7 +5625,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: Model. required: true responses: "200": @@ -5608,7 +5633,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update company information. + summary: Update company information tags: - Operator x-soracom-cli: @@ -5618,13 +5643,13 @@ paths: description: Deletes operator configuration of the namespace. operationId: deleteOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5640,7 +5665,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete operator configuration of the namespace. + summary: Delete operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5649,13 +5674,13 @@ paths: description: Gets operator configuration of the namespace. operationId: getOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5675,7 +5700,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get operator configuration of the namespace. + summary: Get operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5684,13 +5709,13 @@ paths: description: Sets operator configuration of the namespace. operationId: setOperatorConfigurationNamespace parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: Namespace of operator configuration + - description: Namespace of operator configuration. in: path name: namespace required: true @@ -5717,7 +5742,7 @@ paths: security: - api_key: [] api_token: [] - summary: Set operator configuration of the namespace. + summary: Set operator configuration of the namespace tags: - Operator x-soracom-cli: @@ -5727,7 +5752,7 @@ paths: description: Adds the operator's contract. operationId: addOperatorContract parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5738,7 +5763,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContractUpdatingRequest' - description: model + description: Model. required: true responses: "200": @@ -5750,7 +5775,7 @@ paths: security: - api_key: [] api_token: [] - summary: Add Operator Contract. + summary: Add Operator Contract tags: - Operator x-soracom-cli: @@ -5760,13 +5785,13 @@ paths: description: Deletes the operator's contract. operationId: deleteOperatorContract parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: contract_name + - description: Contract name. in: path name: contract_name required: true @@ -5774,11 +5799,11 @@ paths: type: string responses: "204": - description: No Content. + description: Deleted. security: - api_key: [] api_token: [] - summary: Delete Operator Contract. + summary: Delete Operator Contract tags: - Operator x-soracom-cli: @@ -5788,13 +5813,13 @@ paths: description: Adds the operator's coverage type. operationId: addCoverageType parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: coverage_type + - description: Coverage type. in: path name: coverage_type required: true @@ -5806,7 +5831,7 @@ paths: security: - api_key: [] api_token: [] - summary: Add coverage type. + summary: Add coverage type tags: - Operator x-soracom-cli: @@ -5816,7 +5841,7 @@ paths: description: Returns a list of email addresses. operationId: listEmails parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5833,7 +5858,7 @@ paths: description: OK. "400": description: | - This operation is allowed only for root user. + Invoked using SAM user credentials. This operation is allowed only for root user. security: - api_key: [] api_token: [] @@ -5847,13 +5872,13 @@ paths: description: Deletes an email address. operationId: deleteEmail parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: email_id + - description: Email address ID. in: path name: email_id required: true @@ -5861,7 +5886,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -5874,13 +5899,13 @@ paths: description: Returns an email address. operationId: getEmail parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: email_id + - description: Email address ID. in: path name: email_id required: true @@ -5906,7 +5931,7 @@ paths: description: Gets the operator's individual information. operationId: getIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5922,7 +5947,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get individual information. + summary: Get individual information tags: - Operator x-soracom-cli: @@ -5931,7 +5956,7 @@ paths: description: Creates the operator's individual information. operationId: createIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5942,7 +5967,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: Model. required: true responses: "201": @@ -5950,7 +5975,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create individual information. + summary: Create individual information tags: - Operator x-soracom-cli: @@ -5959,7 +5984,7 @@ paths: description: Updates the operator's individual information. operationId: updateIndividualInformation parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -5970,7 +5995,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: Model. required: true responses: "200": @@ -5978,7 +6003,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update individual information. + summary: Update individual information tags: - Operator x-soracom-cli: @@ -5988,7 +6013,7 @@ paths: description: Revokes operator's MFA without backup codes. operationId: revokeMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6002,24 +6027,23 @@ paths: required: true responses: "204": - description: Revoked + description: Revoked. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Revoke Operator's MFA. + summary: Revoke Operator's MFA tags: - Operator x-soracom-cli: - operator revoke-mfa get: - description: |- - Gets operator's MFA status. The MFA status is one of `ACTIVE`, + description: Gets operator's MFA status. The MFA status is one of `ACTIVE`, `INACTIVE` or `UNCONFIRMED`. operationId: getMFAStatus parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6031,23 +6055,23 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAStatusOfUseResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Get Operator's MFA Status. + summary: Get Operator's MFA Status tags: - Operator x-soracom-cli: - operator get-mfa-status post: - description: Enables operator's MFA. After calling this APIg, it should be verified + description: Enables operator's MFA. After calling this API, it should be verified by calling `Operator:verifyMFA` API. operationId: enableMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6059,26 +6083,26 @@ paths: application/json: schema: $ref: '#/components/schemas/EnableMFAOTPResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Enable Operator's MFA. + summary: Enable Operator's MFA tags: - Operator x-soracom-cli: - operator enable-mfa /operators/{operator_id}/mfa/verify: post: - description: Verifies operator's MFA with OTP code after calling `Operator:enableMFA` - API. MFA will not be activated unless the MFA OTP is verified with this API. Backup - codes are going to be returned in the response. These codes must be securely - stored. + description: Verifies operator's MFA with OTP code. This API must be called + after calling `Operator:enableMFA`. MFA will not be activated unless the MFA + OTP is verified with this API. Be sure to securely store the backup code returned + in the response to this API. operationId: verifyMFA parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6089,7 +6113,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAAuthenticationRequest' - description: request + description: Request. required: true responses: "200": @@ -6097,13 +6121,13 @@ paths: application/json: schema: $ref: '#/components/schemas/OperatorMFAVerifyingResponse' - description: OK + description: OK. "400": - description: Bad request + description: Bad request. security: - api_key: [] api_token: [] - summary: Verify Operator's MFA OTP Code. + summary: Verify Operator's MFA OTP Code tags: - Operator x-soracom-cli: @@ -6113,7 +6137,7 @@ paths: description: Updates the operator's password. operationId: updateOperatorPassword parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6124,7 +6148,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePasswordRequest' - description: current password, new password + description: current password, new password. required: true responses: "200": @@ -6134,7 +6158,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update Operator Password. + summary: Update Operator Password tags: - Operator x-soracom-cli: @@ -6144,7 +6168,7 @@ paths: description: Returns a list of roles. operationId: listRoles parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6162,7 +6186,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Roles. + summary: List Roles tags: - Role x-soracom-cli: @@ -6172,13 +6196,13 @@ paths: description: Deletes a role. operationId: deleteRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6194,7 +6218,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Role. + summary: Delete Role tags: - Role x-soracom-cli: @@ -6203,13 +6227,13 @@ paths: description: Retrieves a role. operationId: getRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6227,7 +6251,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Role. + summary: Get Role tags: - Role x-soracom-cli: @@ -6236,13 +6260,13 @@ paths: description: Adds a new role. operationId: createRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6253,7 +6277,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: Permission. required: true responses: "200": @@ -6267,7 +6291,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create Role. + summary: Create Role tags: - Role x-soracom-cli: @@ -6276,13 +6300,13 @@ paths: description: Edits a role. operationId: updateRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6293,17 +6317,17 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: Permission. required: true responses: "200": - description: OK + description: OK. "404": description: Role not found. security: - api_key: [] api_token: [] - summary: Update Role. + summary: Update Role tags: - Role x-soracom-cli: @@ -6313,13 +6337,13 @@ paths: description: Retrieves a list of users attached to a role. operationId: listRoleAttachedUsers parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -6339,7 +6363,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Role Attached Users. + summary: List Role Attached Users tags: - Role x-soracom-cli: @@ -6349,7 +6373,7 @@ paths: description: Returns a list of shipping addresses. operationId: listShippingAddresses parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6365,7 +6389,7 @@ paths: security: - api_key: [] api_token: [] - summary: List shipping addresses. + summary: List shipping addresses tags: - ShippingAddress x-soracom-cli: @@ -6374,7 +6398,7 @@ paths: description: Creates a new shipping address. operationId: createShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6385,7 +6409,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: Shipping address. required: true responses: "201": @@ -6397,7 +6421,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create shipping address. + summary: Create shipping address tags: - ShippingAddress x-soracom-cli: @@ -6407,13 +6431,13 @@ paths: description: Deletes a shipping address. operationId: deleteShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6421,11 +6445,11 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Delete shipping address. + summary: Delete shipping address tags: - ShippingAddress x-soracom-cli: @@ -6434,13 +6458,13 @@ paths: description: Returns a shipping address. operationId: getShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6456,7 +6480,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get shipping address. + summary: Get shipping address tags: - ShippingAddress x-soracom-cli: @@ -6465,13 +6489,13 @@ paths: description: Updates a shipping address. operationId: updateShippingAddress parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: Shipping address ID. in: path name: shipping_address_id required: true @@ -6482,15 +6506,15 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: Shipping address. required: true responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Update shipping address. + summary: Update shipping address tags: - ShippingAddress x-soracom-cli: @@ -6500,7 +6524,7 @@ paths: description: Returns a token for accessing the support console. operationId: generateSupportToken parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6514,20 +6538,20 @@ paths: $ref: '#/components/schemas/SupportTokenResponse' description: OK. "400": - description: Invalid Operator Id + description: Invalid Operator Id. "403": description: Invalid token. security: - api_key: [] api_token: [] - summary: Generate Token for Support Console. + summary: Generate Token for Support Console tags: - Operator x-soracom-cli: - operator get-support-token /operators/{operator_id}/system_notifications: get: - description: Returns a list of system notifications. + description: Returns a list of email settings. operationId: listSystemNotifications parameters: - description: Operator ID @@ -6548,23 +6572,23 @@ paths: security: - api_key: [] api_token: [] - summary: List system notifications + summary: List email settings tags: - SystemNotification x-soracom-cli: - system-notifications list /operators/{operator_id}/system_notifications/{type}: delete: - description: Deletes a system notification. + description: Delete an email address from the email settings. operationId: deleteSystemNotification parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6576,26 +6600,26 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Delete system notification + summary: Delete an email address from the email settings tags: - SystemNotification x-soracom-cli: - system-notifications delete get: - description: Returns a system notification. + description: Return information on email settings. operationId: getSystemNotification parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6616,13 +6640,13 @@ paths: security: - api_key: [] api_token: [] - summary: Get system notification + summary: Get information on email settings tags: - SystemNotification x-soracom-cli: - system-notifications get post: - description: Sets a system notification. + description: Set an email address in the email settings. operationId: setSystemNotification parameters: - description: Operator ID @@ -6631,7 +6655,7 @@ paths: required: true schema: type: string - - description: system notification type + - description: Email address type. in: path name: type required: true @@ -6647,7 +6671,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetSystemNotificationsRequest' - description: request + description: Request. required: true responses: "200": @@ -6655,11 +6679,11 @@ paths: application/json: schema: $ref: '#/components/schemas/SystemNotificationsModel' - description: OK + description: OK. security: - api_key: [] api_token: [] - summary: Set system notification + summary: Set an email address in the email settings tags: - SystemNotification x-soracom-cli: @@ -6671,7 +6695,7 @@ paths: new API token. You can then use the new API token in future requests. operationId: generateAuthToken parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6682,7 +6706,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GenerateTokenRequest' - description: token timeout seconds + description: Token timeout seconds. required: true responses: "200": @@ -6702,7 +6726,7 @@ paths: security: - api_key: [] api_token: [] - summary: Generate Authentication Token. + summary: Generate API Token tags: - Operator x-soracom-cli: @@ -6710,11 +6734,11 @@ paths: /operators/{operator_id}/tokens: delete: description: Revoke all API keys and API tokens that were generated by the root - user. Once revoked, the API key and API token cannot be used to call the SORACOM + user. Once revoked, the API key and API token cannot be used to call the Soracom API, regardless of their expiration time. operationId: revokeOperatorAuthTokens parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -6724,12 +6748,12 @@ paths: "204": description: Successfully revoked all API keys and API tokens. "400": - description: Wrong operator ID was specified. + description: Invalid Operator Id. security: - api_key: [] api_token: [] summary: Revoke all API keys and API tokens that were generated by the root - user. + user tags: - Operator x-soracom-cli: @@ -7411,13 +7435,13 @@ paths: description: Retrieves a list of the user's roles. operationId: listUserRoles parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true @@ -7437,7 +7461,7 @@ paths: security: - api_key: [] api_token: [] - summary: List User Roles. + summary: List User Roles tags: - Role x-soracom-cli: @@ -7446,13 +7470,13 @@ paths: description: Attaches a role to a user. operationId: attachRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true @@ -7463,11 +7487,11 @@ paths: application/json: schema: $ref: '#/components/schemas/AttachRoleRequest' - description: role_id + description: Role ID. required: true responses: "200": - description: OK + description: OK. "400": description: The role has already been attached or not found. "404": @@ -7475,7 +7499,7 @@ paths: security: - api_key: [] api_token: [] - summary: Attach Role to User. + summary: Attach Role to User tags: - Role x-soracom-cli: @@ -7485,19 +7509,19 @@ paths: description: Detaches a role from a user. operationId: detachRole parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM user name. in: path name: user_name required: true schema: type: string - - description: role_id + - description: Role ID. in: path name: role_id required: true @@ -7505,13 +7529,13 @@ paths: type: string responses: "200": - description: OK + description: OK. "404": description: SAM user or role not found. security: - api_key: [] api_token: [] - summary: Detach Role from User. + summary: Detach Role from User tags: - Role x-soracom-cli: @@ -7554,7 +7578,7 @@ paths: description: Deletes user trust policy for switching user. operationId: deleteUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7583,7 +7607,7 @@ paths: description: Gets user trust policy for switching user. operationId: getUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7619,7 +7643,7 @@ paths: **Warning**: Setting a trust policy will allow the operator(s) or user(s) specified in the request body to switch to this SAM user. When switching, the trusted operator(s) or user(s) will be granted the same permissions as this SAM user, and may be able to see session history, traffic history, and other account information. operationId: updateUserTrustPolicy parameters: - - description: Operator ID + - description: Operator ID. in: path name: operator_id required: true @@ -7646,7 +7670,7 @@ paths: security: - api_key: [] api_token: [] - summary: Updates user trust policy. + summary: Updates user trust policy tags: - User x-soracom-cli: @@ -7743,18 +7767,18 @@ paths: - users default-permissions update /operators/add_email_token/issue: post: - description: Sends an email with a one-time token for adding an e-mail address. + description: Sends an email with a one-time token for adding an email address. operationId: issueAddEmailToken requestBody: content: application/json: schema: $ref: '#/components/schemas/IssueAddEmailTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": description: Exceeds maximum number of emails. security: @@ -7774,11 +7798,11 @@ paths: application/json: schema: $ref: '#/components/schemas/VerifyAddEmailTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. summary: Verify a token to add an email address tags: - Email @@ -7794,16 +7818,16 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAIssueRevokingTokenRequest' - description: request + description: Request. required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: Bad request. "404": - description: Operator not found - summary: Issue Operator's MFA Revoke Token. + description: Operator not found. + summary: Issue Operator's MFA Revoke Token tags: - Operator x-soracom-cli: @@ -7819,50 +7843,26 @@ paths: application/json: schema: $ref: '#/components/schemas/MFARevokingTokenVerifyRequest' - description: request + description: Request. required: true responses: "200": - description: Revoked + description: Revoked. "400": - description: Bad request + description: Bad request. "403": - description: Invalid username or password - summary: Verify Operator's MFA revoke token. + description: Invalid username or password. + summary: Verify Operator's MFA revoke token tags: - Operator x-soracom-cli: - operator verify-mfa-revoke-token - /operators/verify: - post: - description: Verifies the operator's registration. Called by setting as parameter - the one-time verification token received via e-mail. - operationId: verifyOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VerifyOperatorsRequest' - description: token - required: true - responses: - "200": - description: Registration successful. - "400": - description: The one-time token is incorrect. - "404": - description: The one-time token has expired. - summary: Verify Operator. - tags: - - Operator - x-soracom-cli: - - operator verify /orders: get: description: | Get a list of confirmed order history. - **Warning**: You can only obtain order history for the past 18 months. If you need the order history before that time, please contact [SORACOM Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listOrders responses: "200": @@ -7874,13 +7874,13 @@ paths: security: - api_key: [] api_token: [] - summary: Get a list of confirmed order history. + summary: Get a list of confirmed order history tags: - Order x-soracom-cli: - orders list post: - description: Creates a new order quotation. If the orderId is put in /confirm, + description: Creates a new order quotation. If the orderId is put in /orders/{order_id}/confirm, the order is complete. operationId: createQuotation requestBody: @@ -7888,7 +7888,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateEstimatedOrderRequest' - description: Order item list and shipping address ID + description: Order item list and shipping address ID. required: true responses: "201": @@ -7900,7 +7900,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create Quotation. + summary: Create Quotation tags: - Order x-soracom-cli: @@ -7910,10 +7910,10 @@ paths: description: | Returns a confirmed order. - **Warning**: You can only obtain a confirmed order for the past 18 months. If you need the confirmed order before that time, please contact [SORACOM Support](https://support.soracom.io). + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7929,7 +7929,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get a confirmed order. + summary: Get a confirmed order tags: - Order x-soracom-cli: @@ -7940,7 +7940,7 @@ paths: error is returned. operationId: cancelOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7956,18 +7956,20 @@ paths: security: - api_key: [] api_token: [] - summary: Cancel order. + summary: Cancel order tags: - Order x-soracom-cli: - orders cancel /orders/{order_id}/confirm: put: - description: Performs a credit limit and confirms the order if no problems are - encountered. + description: | + Performs a credit limit and confirms the order if no problems are encountered. + + **Warning**: Only orders completed within the past month can be confirmed. If one month has elapsed, please redo the order placement operation. operationId: confirmOrder parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -7979,17 +7981,20 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm order. + summary: Confirm order tags: - Order x-soracom-cli: - orders confirm /orders/{order_id}/resource_initial_setting: put: - description: Update resource initial setting for an order + description: | + Update resource initial setting for an order. + + **Warning**: Initial settings of IoT SIM cannot be specified after confirmation of receipt. operationId: updateOrderedResourceInitialSetting parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -8000,7 +8005,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ResourceInitialSetting' - description: Resource initial setting for an order + description: Resource initial setting for an order. required: true responses: "200": @@ -8016,24 +8021,28 @@ paths: security: - api_key: [] api_token: [] - summary: Update resource initial setting for an order. + summary: Update resource initial setting for an order tags: - Order x-soracom-cli: - orders resource-initial-setting update /orders/{order_id}/subscribers: get: - description: List ordered subscribers + description: | + List ordered subscribers. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listOrderedSubscribers parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true schema: type: string - - description: Serial number of the last subscriber in the previous page that - is set to response header with X-Soracom-Next-Key. + - description: The value of the `x-soracom-next-key` header returned when the + previous page was retrieved. Specify if the next page is to be retrieved. + For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination). in: query name: last_evaluated_key required: false @@ -8056,7 +8065,7 @@ paths: security: - api_key: [] api_token: [] - summary: List ordered subscribers. + summary: List ordered subscribers tags: - Order x-soracom-cli: @@ -8068,10 +8077,13 @@ paths: header: x-soracom-next-key /orders/{order_id}/subscribers/register: post: - description: Registers the ordered SIM with the operator. + description: | + Registers the ordered SIM with the operator. + + **Warning**: IoT SIMs can only be registered for the past 18 months. If you need to register an IoT SIM that was ordered before the time period, please contact [Soracom Support](https://support.soracom.io). operationId: registerOrderedSim parameters: - - description: Order ID. You can get it by calling [`Order:listOrders API`](#/Order/listOrders). + - description: Order ID. You can get it by calling [`Order:listOrders API`](#!/Order/listOrders). in: path name: order_id required: true @@ -8087,18 +8099,21 @@ paths: security: - api_key: [] api_token: [] - summary: Register subscribers for operator. + summary: Register subscribers for operator tags: - Order x-soracom-cli: - orders register-subscribers /payment_history/transactions/{payment_transaction_id}: get: - description: Returns result of a payment transaction. + description: | + Returns result of a payment transaction. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getPaymentTransaction parameters: - description: Payment transaction ID. It can be obtained via [Billing:getBillingHistory - API](#/Billing/getBillingHistory) or [Billing:getBilling API](#/Billing/getBilling). + API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling). in: path name: payment_transaction_id required: true @@ -8140,7 +8155,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get payment method information. + summary: Get current payment method information. tags: - Payment x-soracom-cli: @@ -8161,14 +8176,17 @@ paths: security: - api_key: [] api_token: [] - summary: Activate payment method. + summary: Activate current payment method tags: - Payment x-soracom-cli: - payment-methods reactivate-current /payment_statements: get: - description: List payment statements. + description: | + List payment statements. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listPaymentStatements responses: "200": @@ -8180,14 +8198,17 @@ paths: security: - api_key: [] api_token: [] - summary: List payment statements. + summary: List payment statements tags: - Payment x-soracom-cli: - payment-statements list /payment_statements/{payment_statement_id}/export: post: - description: Export payment statement. + description: | + Export payment statement. + + **Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: exportPaymentStatement parameters: - description: Payment statement ID @@ -8217,7 +8238,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export payment statement. + summary: Export payment statement tags: - Payment x-soracom-cli: @@ -8238,7 +8259,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export payer information. + summary: Export payer information tags: - Payment x-soracom-cli: @@ -8251,7 +8272,7 @@ paths: application/json: schema: $ref: '#/components/schemas/RegisterPayerInformationModel' - description: Payer information to be registered in the accounting specification + description: Payer information to be registered in the accounting specification. required: true responses: "201": @@ -8261,7 +8282,7 @@ paths: security: - api_key: [] api_token: [] - summary: Register payer information. + summary: Register payer information tags: - Payment x-soracom-cli: @@ -8277,8 +8298,8 @@ paths: required: false schema: type: integer - - description: The last Port Mapping ID retrieved on the current page. By specifying - this parameter, you can continue to retrieve the list from the next group + - description: The last Port Mapping ID retrieved on the previous page. By specifying + this parameter, you can continue to retrieve the list from the next entry onward. in: query name: last_evaluated_key @@ -8297,7 +8318,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Port Mapping Entries. + summary: List Port Mapping Entries tags: - PortMapping x-soracom-cli: @@ -8323,27 +8344,27 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create Port Mapping. + summary: Create Port Mapping tags: - PortMapping x-soracom-cli: - port-mappings create /port_mappings/{ip_address}/{port}: delete: - description: Deletes the specified port mapping entry + description: Deletes the specified port mapping entry. operationId: deletePortMapping parameters: - - description: IP address of the target port mapping entry + - description: IP address of the target port mapping entry. in: path name: ip_address required: true schema: type: string - - description: Port of the target port mapping entry + - description: Port of the target port mapping entry. in: path name: port required: true @@ -8357,7 +8378,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete PortMapping. + summary: Delete Port Mapping tags: - PortMapping x-soracom-cli: @@ -8367,7 +8388,7 @@ paths: description: Returns the port mapping entries for a subscriber. operationId: listPortMappingsForSubscriber parameters: - - description: Target subscriber IMSI. + - description: IMSI of the target subscriber. in: path name: imsi required: true @@ -8385,7 +8406,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Port Mapping entries for a subscriber. + summary: Get Port Mapping entries for a subscriber tags: - PortMapping x-soracom-cli: @@ -8394,6 +8415,12 @@ paths: get: description: Returns a list of products. operationId: listProducts + parameters: + - in: query + name: campaign_code + required: false + schema: + type: string responses: "200": content: @@ -8404,7 +8431,7 @@ paths: security: - api_key: [] api_token: [] - summary: List products. + summary: List products tags: - Order x-soracom-cli: @@ -8417,7 +8444,7 @@ paths: information. operationId: searchDevices parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8426,7 +8453,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8435,7 +8462,7 @@ paths: items: type: string type: array - - description: SORACOM Inventory device ID to search + - description: SORACOM Inventory device ID to search. explode: true in: query name: deviceId @@ -8444,7 +8471,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8453,7 +8480,7 @@ paths: items: type: string type: array - - description: IMSI of the device that was used on bootstrapping + - description: IMSI of the device that was used on bootstrapping. explode: true in: query name: imsi @@ -8462,7 +8489,7 @@ paths: items: type: string type: array - - description: IMEI of the device that was used on bootstrapping + - description: IMEI of the device that was used on bootstrapping. explode: true in: query name: imei @@ -8471,7 +8498,7 @@ paths: items: type: string type: array - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8481,14 +8508,14 @@ paths: maximum: 100 type: integer - description: The SORACOM Inventory device ID of the last Inventory device - retrieved on the current page. By specifying this parameter, you can continue + retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward. in: query name: last_evaluated_key required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8506,9 +8533,9 @@ paths: items: $ref: '#/components/schemas/Device' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8529,7 +8556,7 @@ paths: and retrieve all Sigfox devices that includes their group information. operationId: searchSigfoxDevices parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8538,7 +8565,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8547,7 +8574,7 @@ paths: items: type: string type: array - - description: Sigfox device ID to search + - description: Sigfox device ID to search. explode: true in: query name: deviceId @@ -8556,7 +8583,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8565,7 +8592,7 @@ paths: items: type: string type: array - - description: Status of sigfox devices + - description: Status of sigfox devices. in: query name: status required: false @@ -8582,7 +8609,7 @@ paths: - banned - standby type: string - - description: Registration status of sigfox devices + - description: Registration status of sigfox devices. in: query name: registration required: false @@ -8594,7 +8621,7 @@ paths: - success - failed type: string - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8604,14 +8631,14 @@ paths: maximum: 100 type: integer - description: The Sigfox device ID of the last Sigfox device retrieved on the - current page. By specifying this parameter, you can continue to retrieve + previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward. in: query name: last_evaluated_key required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8629,9 +8656,9 @@ paths: items: $ref: '#/components/schemas/SigfoxDevice' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8647,12 +8674,13 @@ paths: header: x-soracom-next-key /query/sims: get: - description: Search SIMs by query terms. It returns partial match results. When - this API permission is allowed, it grants the authority to search and retrieve - all SIMs that includes their group information. + description: | + Search SIMs by query terms. It returns partial match results. It is case-insensitive. + + **Warning**: When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information. operationId: searchSims parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8661,7 +8689,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8670,7 +8698,7 @@ paths: items: type: string type: array - - description: Identifier of the SIM to search + - description: Identifier of the SIM to search. explode: true in: query name: sim_id @@ -8679,7 +8707,7 @@ paths: items: type: string type: array - - description: IMSI to search + - description: IMSI to search. explode: true in: query name: imsi @@ -8688,7 +8716,7 @@ paths: items: type: string type: array - - description: MSISDN to search + - description: MSISDN to search. explode: true in: query name: msisdn @@ -8697,7 +8725,8 @@ paths: items: type: string type: array - - description: ICCID to search + - description: ICCID to search. An identifier to identify a SIM card or virtual + IoT SIM (Virtual SIM/Subscriber). explode: true in: query name: iccid @@ -8706,7 +8735,8 @@ paths: items: type: string type: array - - description: Serial number to search + - description: Serial number to search. This is set only for IoT SIMs for specific + regions. explode: true in: query name: serial_number @@ -8715,7 +8745,8 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. For more information, please + refer to [Using Tags with Soracom Air](/docs/air/tags). explode: true in: query name: tag @@ -8724,7 +8755,7 @@ paths: items: type: string type: array - - description: Bundles type to search + - description: Bundles type to search. explode: true in: query name: bundles @@ -8733,7 +8764,12 @@ paths: items: type: string type: array - - description: Status of the session to search (ONLINE or OFFLINE) + - description: | + Status of the session to search (ONLINE or OFFLINE). + + - `NA`: Any. + - `ONLINE`: Online. + - `OFFLINE`: Offline. in: query name: session_status required: false @@ -8745,7 +8781,7 @@ paths: - OFFLINE format: string type: string - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8754,7 +8790,7 @@ paths: format: int32 maximum: 100 type: integer - - description: The SIM ID of the last SIM retrieved on the current page. By + - description: The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward. in: query @@ -8762,7 +8798,8 @@ paths: required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). If omitted, + it is an AND search. in: query name: search_type required: false @@ -8780,9 +8817,9 @@ paths: items: $ref: '#/components/schemas/Sim' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8799,13 +8836,13 @@ paths: /query/subscribers: get: deprecated: true - description: '(DEPRECATED: please consider to use `/query/sims` API instead) - Search subscribers by query terms. It returns partial match results. When + description: '(DEPRECATED: please consider to use `/query/sims` API instead + ) Search subscribers by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information.' operationId: searchSubscribers parameters: - - description: Name to search + - description: Name to search. explode: true in: query name: name @@ -8814,7 +8851,7 @@ paths: items: type: string type: array - - description: Group name to search + - description: Group name to search. explode: true in: query name: group @@ -8823,7 +8860,7 @@ paths: items: type: string type: array - - description: IMSI to search + - description: IMSI to search. explode: true in: query name: imsi @@ -8832,7 +8869,7 @@ paths: items: type: string type: array - - description: MSISDN to search + - description: MSISDN to search. explode: true in: query name: msisdn @@ -8841,7 +8878,7 @@ paths: items: type: string type: array - - description: ICCID to search + - description: ICCID to search. explode: true in: query name: iccid @@ -8850,7 +8887,7 @@ paths: items: type: string type: array - - description: Serial number to search + - description: Serial number to search. explode: true in: query name: serial_number @@ -8859,7 +8896,7 @@ paths: items: type: string type: array - - description: String of tag values to search + - description: String of tag values to search. explode: true in: query name: tag @@ -8868,7 +8905,7 @@ paths: items: type: string type: array - - description: Subscription (e.g. `plan01s`) to search + - description: Subscription (e.g. `plan01s`) to search. explode: true in: query name: subscription @@ -8877,7 +8914,7 @@ paths: items: type: string type: array - - description: Module type (e.g. `mini`, `virtual`) to search + - description: Module type (e.g. `mini`, `virtual`) to search. explode: true in: query name: module_type @@ -8886,7 +8923,7 @@ paths: items: type: string type: array - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8895,7 +8932,7 @@ paths: format: int32 maximum: 100 type: integer - - description: The IMSI of the last subscriber retrieved on the current page. + - description: The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward. in: query @@ -8903,7 +8940,7 @@ paths: required: false schema: type: string - - description: Type of the search ('AND searching' or 'OR searching') + - description: Type of the search ('AND searching' or 'OR searching'). in: query name: search_type required: false @@ -8921,9 +8958,9 @@ paths: items: $ref: '#/components/schemas/Subscriber' type: array - description: Returns result of searching + description: Returns result of searching. "400": - description: Invalid search queries + description: Invalid search queries. security: - api_key: [] api_token: [] @@ -8940,24 +8977,24 @@ paths: header: x-soracom-next-key /query/subscribers/traffic_volume/ranking: get: - description: Search traffic volume ranking of subscribers + description: Search traffic volume ranking of subscribers. operationId: searchSubscriberTrafficVolumeRanking parameters: - - description: 'The beginning point of searching range (unixtime: in milliseconds)' + - description: The beginning point of searching range (UNIX time in milliseconds). in: query name: from required: true schema: format: int64 type: integer - - description: 'The end point of searching range (unixtime: in milliseconds)' + - description: The end point of searching range (UNIX time in milliseconds). in: query name: to required: true schema: format: int64 type: integer - - description: The maximum number of item to retrieve + - description: The maximum number of item to retrieve. in: query name: limit required: false @@ -8966,7 +9003,7 @@ paths: format: int32 maximum: 500 type: integer - - description: The order of ranking + - description: The order of ranking. in: query name: order required: false @@ -8984,7 +9021,7 @@ paths: items: $ref: '#/components/schemas/TrafficVolumeRanking' type: array - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -9002,7 +9039,7 @@ paths: - description: | The type of the resource summary. - - `simsPerStatus`: The number of IoT SIMs per status + - `simsPerStatus`: The number of IoT SIMs per status. in: path name: resource_summary_type required: true @@ -9022,7 +9059,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get the resource summary identified by resource_summary_type. + summary: Get the resource summary identified by resource_summary_type tags: - ResourceSummary x-soracom-cli: @@ -9155,11 +9192,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list @@ -9747,11 +9787,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward. @@ -10032,7 +10075,7 @@ paths: security: - api_key: [] api_token: [] - summary: Lists packet capture sessions associated with the SIM. + summary: Lists packet capture sessions associated with the SIM tags: - Sim x-soracom-cli: @@ -10046,7 +10089,7 @@ paths: description: Creates a packet capture session associated with the SIM. operationId: createSimPacketCaptureSession parameters: - - description: The SIM ID for which a packet capture session is created + - description: SIM ID of the target SIM. in: path name: sim_id required: true @@ -10065,7 +10108,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Created a new packet capture session associated with the SIM + description: The packet capture session associated with the SIM "400": description: Failed to create a packet capture session for the specified SIM @@ -10074,14 +10117,14 @@ paths: security: - api_key: [] api_token: [] - summary: Creates a packet capture session associated with the SIM. + summary: Creates a packet capture session associated with the SIM tags: - Sim x-soracom-cli: - sims create-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}: delete: - description: Deletes a packet capture session associated with the SIM + description: Deletes a packet capture session associated with the SIM. operationId: deleteSimPacketCaptureSession parameters: - description: SIM ID of the target SIM. @@ -10102,7 +10145,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Deleted the packet capture session associated with the SIM + description: Deleted the packet capture session "400": description: Failed to delete the packet capture session associated with the SIM @@ -10118,7 +10161,7 @@ paths: x-soracom-cli: - sims delete-packet-capture-session get: - description: Gets a packet capture session associated the SIM + description: Gets a packet capture session associated with the SIM. operationId: getSimPacketCaptureSession parameters: - description: SIM ID of the target SIM. @@ -10146,7 +10189,7 @@ paths: security: - api_key: [] api_token: [] - summary: Gets a packet capture session associated the SIM + summary: Gets a packet capture session associated with the SIM tags: - Sim x-soracom-cli: @@ -10174,7 +10217,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: The stopped packet capture session associated with the SIM + description: The stopped packet capture session "400": description: The packet capture session can be stopped only when its status is CAPTURING @@ -10186,7 +10229,7 @@ paths: security: - api_key: [] api_token: [] - summary: Stops a SIM packet capture session + summary: Stops a packet capture session associated with the SIM tags: - Sim x-soracom-cli: @@ -10654,6 +10697,94 @@ paths: - Sim x-soracom-cli: - sims set-to-standby + /sims/{sim_id}/statuses/history: + get: + description: List IoT SIM status operation history. Status operation history + entry records what status operations were performed for which IMSI and which + subscriptions, along with the operation time. It includes speed class, group + ID, IoT SIM status, etc. If the total number of status operation history entry + does not fit in one page, a URL for accessing the next page is returned in + the 'link' header of the response. + operationId: listSimStatusHistory + parameters: + - description: SIM ID of the target SIM. + in: path + name: sim_id + required: true + schema: + type: string + - description: Start time of the status operation history entry to be searched + (UNIX time in milliseconds). If not specified, `from` is set to the oldest + status operation history entry time of the target IoT SIM. + in: query + name: from + required: false + schema: + type: integer + - description: End time of the status operation history entry to be searched + (UNIX time in milliseconds). If not specified, `to` is set to the current + time. + in: query + name: to + required: false + schema: + type: integer + - description: A string consisting of the primary IMSI and the timestamp (UNIX + time in milliseconds) of the last status operation history entry obtained + on the previous page, concatenated with `@`. By specifying this parameter, + you can continue to retrieve the list from the next page onward. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Sort order of status operation history entry. Either descending + (latest data entry first) or ascending (oldest data entry first). + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + - description: Maximum number of items to retrieve in one request. The response + may contain fewer items than the specified limit. + in: query + name: limit + required: false + schema: + default: 30 + maximum: 100 + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SimStatusHistoryResponse' + type: array + description: A list of status operation history entry of the IoT SIM. + "400": + description: Bad request. + "404": + description: No such SIM found. + security: + - api_key: [] + api_token: [] + summary: List IoT SIM status operation history + tags: + - Sim + x-soracom-cli: + - sims list-status-history + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sims/{sim_id}/suspend: post: description: Changes status of specified SIM to "suspended". @@ -10906,9 +11037,9 @@ paths: /sora_cam/devices: get: description: | - Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services. You can also retrieve information on cameras for which a license has not been assigned. + Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDevices responses: "200": @@ -10944,7 +11075,7 @@ paths: description: | Obtain a SoraCam device record for the device identified by device_id. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDevice parameters: - description: Device ID of the target compatible camera device. @@ -10985,110 +11116,56 @@ paths: - SoraCam x-soracom-cli: - sora-cam devices get - /sora_cam/devices/{device_id}/events: + /sora_cam/devices/{device_id}/atomcam/settings: get: description: | - Returns list of SoraCam events for the specified device. - operationId: listSoraCamDeviceEventsForDevice + Retrieve the camera's various settings. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettings parameters: - - description: ID of the target SoraCam device. + - description: Device ID of the target compatible camera device. in: path name: device_id required: true schema: type: string - - description: Value of the x-soracom-next-key header in the response to the - last listSoraCamDeviceEventsForDevice request. By specifying this parameter, - you can continue to retrieve the list from the last request. - in: query - name: last_evaluated_key - required: false - schema: - type: string - - description: Maximum number of items to retrieve in one request. Note that - the response may contain fewer items than the specified limit. - in: query - name: limit - required: false - schema: - default: 10 - type: integer - - description: Start time of the events to be searched (unix time in milliseconds). - If not specified, `from` is set to the oldest event time. - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: End time of the events to be searched (unix time in milliseconds). - If not specified, `to` is set to the current time. - in: query - name: to - required: false - schema: - format: int64 - type: integer - - description: | - Sort order of the events. - - - `desc`: Descending order (latest data entry first) - - `asc`: Ascending order (oldest data entry first) - in: query - name: sort - required: false - schema: - default: desc - enum: - - desc - - asc - type: string responses: "200": content: application/json: example: - - deviceId: 7CDDDEADBEEF - deviceType: atomCamV2 - eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b - eventInfo: - endTime: 1662973203000 - picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... - recordingStatus: completed - startTime: 1662973200000 - type: motion - time: 1662973200000 - schema: - items: - $ref: '#/components/schemas/SoraCamEvent' - type: array + logo: "on" + motionTagging: "on" + nightVision: auto + quality: high + rotation: 0 + statusLight: "on" + timestamp: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettings' description: OK. - "400": - description: The specified argument is invalid. "404": - description: The specified SoraCam device could not be found. + description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: List SoraCam events for the specified device. + summary: Retrieve the camera's various settings tags: - SoraCam x-soracom-cli: - - sora-cam devices events list-for-device - x-soracom-cli-pagination: - request: - param: last_evaluated_key - response: - header: x-soracom-next-key - /sora_cam/devices/{device_id}/exports/usage: + - sora-cam devices atomcam get-settings + /sora_cam/devices/{device_id}/atomcam/settings/logo: get: description: | - Get the remaining number of still images that can be exported and the remaining exportable time of recorded video. + Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. - **Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: getSoraCamDeviceExportUsage + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsLogo parameters: - description: Device ID of the target compatible camera device. in: path @@ -11101,39 +11178,29 @@ paths: content: application/json: example: - deviceId: 7CDDDEADBEEF - image: - billedFrames: 0 - limitFrames: 259200 - remainingFrames: 259131 - usedFrames: 69 - meteredYearMonth: "202209" - video: - billedSeconds: 0 - limitSeconds: 259200 - remainingSeconds: 259131 - usedSeconds: 69 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsage' + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' description: OK. "404": description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: Get the remaining number of still images that can be exported and the - remaining exportable time of recorded video. + summary: Retrieve the display settings for the ATOM tech Inc. logo shown on + the bottom left of the captured image tags: - SoraCam x-soracom-cli: - - sora-cam devices get-export-usage - /sora_cam/devices/{device_id}/exports/usage/limit_override: - delete: + - sora-cam devices atomcam settings get-logo + post: description: | - Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month. + Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: deleteSoraCamDeviceExportUsageLimitOverride + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsLogo parameters: - description: Device ID of the target compatible camera device. in: path @@ -11141,30 +11208,38 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' responses: - "204": - description: OK, deleted. + "200": + description: OK. + "400": + description: The specified value is invalid. "404": description: The specified compatible camera device could not be found. security: - api_key: [] api_token: [] - summary: Reset the monthly limit on the recorded video time available for export - for compatible camera device to the default value. + summary: Change the display settings for the ATOM tech Inc. logo shown on the + bottom left of the captured image tags: - SoraCam x-soracom-cli: - - sora-cam devices delete-export-usage-limit-override - put: + - sora-cam devices atomcam settings set-logo + /sora_cam/devices/{device_id}/atomcam/settings/motion_tagging: + get: description: | - Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set. + Retrieve the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. - **Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Services [about fees](https://soracom.jp/sora_cam/#pricing) (Japanese). - - **Warning**: The monthly limit can be set to less than 72 hours. In such cases, there will be no change in the charge. + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). - operationId: updateSoraCamDeviceExportUsageLimitOverride + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsMotionTagging parameters: - description: Device ID of the target compatible camera device. in: path @@ -11172,9 +11247,618 @@ paths: required: true schema: type: string - requestBody: - content: - application/json: + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the display settings for motion tagging + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-motion-tagging + post: + description: | + Change the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsMotionTagging + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the display settings for motion tagging + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-motion-tagging + /sora_cam/devices/{device_id}/atomcam/settings/night_vision: + get: + description: | + Retrieve the settings for night vision mode. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for night vision mode + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-night-vision + post: + description: | + Change the settings for night vision mode. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for night vision mode + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-night-vision + /sora_cam/devices/{device_id}/atomcam/settings/quality: + get: + description: | + Retrieve the quality settings for cloud recording. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the quality settings for cloud recording + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-quality + post: + description: | + Change the quality settings for cloud recording. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the quality settings for cloud recording + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-quality + /sora_cam/devices/{device_id}/atomcam/settings/rotation: + get: + description: | + Retrieve the settings for rotating the image by 180 degrees. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for rotating the image by 180 degrees + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-rotation + post: + description: | + Change the settings for rotating the image by 180 degrees. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for rotating the image by 180 degrees + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-rotation + /sora_cam/devices/{device_id}/atomcam/settings/status_light: + get: + description: | + Retrieve the settings for the status light (indicator light that shows the status of the camera). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the settings for the status light (indicator light that shows + the status of the camera) + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-status-light + post: + description: | + Change the settings for the status light (indicator light that shows the status of the camera). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the settings for the status light (indicator light that shows + the status of the camera) + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-status-light + /sora_cam/devices/{device_id}/atomcam/settings/timestamp: + get: + description: | + Retrieve the display settings for the timestamp shown on the bottom right of the captured image. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: getSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Retrieve the display settings for the timestamp shown on the bottom + right of the captured image + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-timestamp + post: + description: | + Change the display settings for the timestamp shown on the bottom right of the captured image. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + + **Info**: This API is currently available as a beta release. Functionality may be subject to change. + operationId: setSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Change the display settings for the timestamp shown on the bottom right + of the captured image + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-timestamp + /sora_cam/devices/{device_id}/events: + get: + description: | + Returns list of SoraCam events for the specified device. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: listSoraCamDeviceEventsForDevice + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + - description: Value of the x-soracom-next-key header in the response to the + last listSoraCamDeviceEventsForDevice request. By specifying this parameter, + you can continue to retrieve the list from the last request. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Maximum number of items to retrieve in one request. Note that + the response may contain fewer items than the specified limit. + in: query + name: limit + required: false + schema: + default: 10 + type: integer + - description: Start time of the events to be searched (unix time in milliseconds). + If not specified, `from` is set to the oldest event time. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: End time of the events to be searched (unix time in milliseconds). + If not specified, `to` is set to the current time. + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + Sort order of the events. + + - `desc`: Descending order (latest data entry first) + - `asc`: Ascending order (oldest data entry first) + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + responses: + "200": + content: + application/json: + example: + - deviceId: 7CDDDEADBEEF + deviceType: atomCamV2 + eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b + eventInfo: + endTime: 1662973203000 + picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... + recordingStatus: completed + startTime: 1662973200000 + type: motion + time: 1662973200000 + schema: + items: + $ref: '#/components/schemas/SoraCamEvent' + type: array + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: List SoraCam events for the specified device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key + /sora_cam/devices/{device_id}/exports/usage: + get: + description: | + Get the remaining number of still images that can be exported and the remaining exportable time of recorded video. + + **Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default). + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: getSoraCamDeviceExportUsage + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + deviceId: 7CDDDEADBEEF + image: + billedFrames: 0 + limitFrames: 259200 + remainingFrames: 259131 + usedFrames: 69 + meteredYearMonth: "202209" + video: + billedSeconds: 0 + limitSeconds: 259200 + remainingSeconds: 259131 + usedSeconds: 69 + schema: + $ref: '#/components/schemas/SoraCamExportUsage' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the remaining number of still images that can be exported and the + remaining exportable time of recorded video. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-export-usage + /sora_cam/devices/{device_id}/exports/usage/limit_override: + delete: + description: | + Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: deleteSoraCamDeviceExportUsageLimitOverride + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "204": + description: OK, deleted. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Reset the monthly limit on the recorded video time available for export + for compatible camera device to the default value. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices delete-export-usage-limit-override + put: + description: | + Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set. + + **Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Services [about fees](https://soracom.jp/sora_cam/#pricing) (Japanese). + + **Warning**: The monthly limit can be set to less than 72 hours. In such cases, there will be no change in the charge. + + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: updateSoraCamDeviceExportUsageLimitOverride + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: example: limitHours: 144 schema: @@ -11220,7 +11904,7 @@ paths: If the target is not limited to one compatible camera device, but all compatible camera device owned by the operator, use [SoraCam:listSoraCamDeviceImageExports API](#/SoraCam/listSoraCamDeviceImageExports). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceImageExportsForDevice parameters: - description: Device ID of the target compatible camera device. @@ -11343,7 +12027,7 @@ paths: **Warning**: Images from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection "Unlimited" Recording License cannot be exported. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: exportSoraCamDeviceRecordedImage parameters: - description: Device ID of the target compatible camera device. @@ -11393,7 +12077,7 @@ paths: description: | Gets the list of the current status of the process of exporting still image from recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one export process. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceExportedImage parameters: - description: Device ID of the target compatible camera device. @@ -11401,86 +12085,328 @@ paths: name: device_id required: true schema: - type: string - - description: Export ID of the target export operation. - in: path - name: export_id - required: true + type: string + - description: Export ID of the target export operation. + in: path + name: export_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + (1) Initializing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: initializing + (2) Processing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: processing + (3) Completed: + value: + - deviceId: 7CDDDEADBEEF + expiryTime: 1662973800000 + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: completed + url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... + (4) Retrying: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: retrying + (5) Failed: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: failed + (6) limitExceeded: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: limitExceeded + (7) Expired: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: expired + schema: + items: + $ref: '#/components/schemas/SoraCamImageExportInfo' + type: array + description: OK. + "404": + description: The specified compatible camera device or export process could + not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current status of the process of exporting still images from + recorded video taken with a compatible camera device + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images get-exported + /sora_cam/devices/{device_id}/name: + get: + description: Get the current name of the compatible camera device. + operationId: getSoraCamDeviceName + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current name of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-name + post: + description: Changes the name of the compatible camera device. + operationId: setSoraCamDeviceName + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Changes the name of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-name + /sora_cam/devices/{device_id}/power_state: + get: + description: Get the current power state of the compatible camera device. + operationId: getSoraCamDevicePowerState + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Get the current power state of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-power-state + post: + description: Changes the power state of the compatible camera device. + operationId: setSoraCamDevicePowerState + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + responses: + "200": + description: OK. + "400": + description: The specified value is invalid. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Changes the power state of the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-power-state + /sora_cam/devices/{device_id}/reboot: + post: + description: Reboot the compatible camera device. + operationId: rebootSoraCamDevice + parameters: + - description: Device ID of the target compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + description: OK. + "404": + description: The specified compatible camera device could not be found. + security: + - api_key: [] + api_token: [] + summary: Reboot the compatible camera device. + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices reboot + /sora_cam/devices/{device_id}/recordings_and_events: + get: + description: | + Returns a list of recording periods and events for a compatible camera device. + + **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + operationId: listSoraCamDeviceRecordingsAndEvents + parameters: + - description: Device ID of the compatible camera device. + in: path + name: device_id + required: true + schema: + type: string + - description: Value of the x-soracom-next-key header in the response to the + last listSoraCamDeviceRecordingsAndEvents request. By specifying this parameter, + you can continue to retrieve the list from the last request. + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: Start time of the list to be searched (unix time in milliseconds). + If not specified, `from` is set to the oldest time within the retention + period of the license assigned to the compatible camera device. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: End time of the list to be searched (unix time in milliseconds). + If not specified, `to` is set to the current time. + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + Sort order of the recordings and events. + + - `desc`: Descending order (latest data entry first) + - `asc`: Ascending order (oldest data entry first) + in: query + name: sort + required: false schema: + default: desc + enum: + - desc + - asc type: string responses: "200": content: application/json: - examples: - (1) Initializing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: initializing - (2) Processing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: processing - (3) Completed: - value: - - deviceId: 7CDDDEADBEEF - expiryTime: 1662973800000 - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: completed - url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... - (4) Retrying: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: retrying - (5) Failed: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: failed - (6) limitExceeded: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: limitExceeded - (7) Expired: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: expired + example: + events: + - endTime: 1699318810000 + startTime: 1699318800000 + type: motion + - endTime: 1699320820000 + startTime: 1699320810000 + type: sound + - endTime: 1699315210000 + startTime: 1699315200000 + type: motion + records: + - startTime: 1699318800000 + - endTime: 1699318800000 + startTime: 169931520000011 schema: - items: - $ref: '#/components/schemas/SoraCamImageExportInfo' - type: array + $ref: '#/components/schemas/SoraCamRecordingsAndEventsList' description: OK. + "400": + description: The specified argument is invalid. "404": - description: The specified compatible camera device or export process could - not be found. + description: The specified compatible camera device, or the recordings for + the specified period, could not be found. security: - api_key: [] api_token: [] - summary: Get the current status of the process of exporting still images from - recorded video taken with a compatible camera device. + summary: Retrieve a list of recording periods and events for a compatible camera + device tags: - SoraCam x-soracom-cli: - - sora-cam devices images get-exported + - sora-cam devices recordings-and-events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sora_cam/devices/{device_id}/stream: get: description: | @@ -11495,7 +12421,7 @@ paths: **Warning**: Real-time video is a function that retrieves the latest video from recorded video saved on the cloud. Therefore, a Cloud Continuous Recording License or a Cloud Motion Detection "Unlimited" Recording License is required to obtain real-time video. **Live video (P2P)** that can be played on the ATOM app is a different feature from the real-time video. **Live video (P2P)** cannot be obtained using the SORACOM API. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceStreamingVideo parameters: - description: Device ID of the target compatible camera device. @@ -11557,7 +12483,7 @@ paths: If the target is not limited to one compatible camera device, but all compatible camera device owned by the operator, use [SoraCam:listSoraCamDeviceVideoExports API](#/SoraCam/listSoraCamDeviceVideoExports). - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceVideoExportsForDevice parameters: - description: Device ID of the target compatible camera device. @@ -11681,7 +12607,7 @@ paths: **Warning**: Recordings from cameras that have not been assigned a Cloud Continuous Recording License or Cloud Motion Detection "Unlimited" Recording License cannot be exported. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: exportSoraCamDeviceRecordedVideo parameters: - description: Device ID of the target compatible camera device. @@ -11732,7 +12658,7 @@ paths: description: | Gets the list of the current status of the process of exporting recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedVideo API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one export process. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: getSoraCamDeviceExportedVideo parameters: - description: Device ID of the target compatible camera device. @@ -11813,7 +12739,7 @@ paths: - api_key: [] api_token: [] summary: Get the current status of the process of exporting recorded video taken - with a compatible camera device. + with a compatible camera device tags: - SoraCam x-soracom-cli: @@ -11898,7 +12824,7 @@ paths: type: array description: OK. "400": - description: The specified argument is invalid. + description: The specified value is invalid. security: - api_key: [] api_token: [] @@ -11917,7 +12843,7 @@ paths: description: | Gets the list of the current status of the process of exporting still image from recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage). This API can target all devices owned by the operator, or limit it to one compatible camera device. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceImageExports parameters: - description: Device ID of the target compatible camera device. If this ID @@ -12038,7 +12964,7 @@ paths: description: | Gets the list of the current status of the process of exporting recorded video taken with a compatible camera device started by [`SoraCam:exportSoraCamDeviceRecordedVideo API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedVideo). This API can target all devices owned by the operator, or limit it to one compatible camera device. - **Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). + **Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels). operationId: listSoraCamDeviceVideoExports parameters: - description: Device ID of the target compatible camera device. If this ID @@ -12198,7 +13124,7 @@ paths: security: - api_key: [] api_token: [] - summary: List license packs of Soracom Cloud Camera Services. + summary: List license packs of Soracom Cloud Camera Services tags: - SoraCam x-soracom-cli: @@ -12206,11 +13132,11 @@ paths: /sora_cam/license_packs/{license_pack_id}/quantity: put: description: Updates the license quantity for the license pack identified by - license_pack_id. This operation will cost you monthly fee based on - number of licenses. Currently, this API is only available for Japan coverage. + license_pack_id. This operation will cost you monthly fee based on number + of licenses. Currently, this API is only available for Japan coverage. operationId: updateSoraCamLicensePackQuantity parameters: - - description: ID of the license pack + - description: ID of the license pack. in: path name: license_pack_id required: true @@ -12231,7 +13157,7 @@ paths: security: - api_key: [] api_token: [] - summary: Update the license quantity of Soracom Cloud Camera Services. + summary: Update the license quantity of Soracom Cloud Camera Services tags: - SoraCam x-soracom-cli: @@ -12241,7 +13167,8 @@ paths: description: Returns a list of Soralets. operationId: listSoralets parameters: - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12251,7 +13178,7 @@ paths: - asc - desc type: string - - description: The maximum number of items in a response + - description: The maximum number of items in a response. in: query name: limit required: false @@ -12277,7 +13204,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Soralets. + summary: List Soralets tags: - Soralet x-soracom-cli: @@ -12306,7 +13233,7 @@ paths: security: - api_key: [] api_token: [] - summary: Create a Soralet. + summary: Create a Soralet tags: - Soralet x-soracom-cli: @@ -12330,7 +13257,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Soralet. + summary: Delete Soralet tags: - Soralet x-soracom-cli: @@ -12357,7 +13284,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get a Soralet. + summary: Get a Soralet tags: - Soralet x-soracom-cli: @@ -12373,7 +13300,8 @@ paths: required: true schema: type: string - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12409,7 +13337,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get log messages from Soralet. + summary: Get log messages from Soralet tags: - Soralet x-soracom-cli: @@ -12435,7 +13363,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExecuteSoraletRequest' - description: request + description: Execution request. required: true responses: "200": @@ -12447,7 +13375,7 @@ paths: security: - api_key: [] api_token: [] - summary: Execute Soralet with arguments. + summary: Execute Soralet with arguments tags: - Soralet x-soracom-cli: @@ -12464,7 +13392,8 @@ paths: required: true schema: type: string - - description: Sort order + - description: Sort order of the data entries. Either descending (latest data + entry first) or ascending (oldest data entry first). in: query name: sort required: false @@ -12500,7 +13429,7 @@ paths: security: - api_key: [] api_token: [] - summary: List versions of Soralet. + summary: List versions of Soralet tags: - Soralet x-soracom-cli: @@ -12520,7 +13449,8 @@ paths: required: true schema: type: string - - description: Content type of the file to upload + - description: Content type of the file to upload. When uploading .wasm files, + please specify `application/json`. in: header name: content-type schema: @@ -12531,6 +13461,7 @@ paths: schema: format: binary type: string + description: Contents of the file you wish to upload. required: true responses: "201": @@ -12542,7 +13473,7 @@ paths: security: - api_key: [] api_token: [] - summary: Upload code and create a new version. + summary: Upload code and create a new version tags: - Soralet x-soracom-cli: @@ -12572,7 +13503,7 @@ paths: security: - api_key: [] api_token: [] - summary: Delete a Soralet version. + summary: Delete a Soralet version tags: - Soralet x-soracom-cli: @@ -12589,23 +13520,15 @@ paths: required: true schema: type: string - - description: "Start time for the aggregate data (UNIX time in seconds).\n\n- - If period is set to \"month\", valid values range from 3 months ago to the - current time. \n- If period is set to \"day\", valid values range from 6 - days ago to the current time. \n- The actual start time of the - period is 00:00:00 on the first day of the month or day containing the specified - UNIX time.\n" + - description: Specify the start month/day of the period to be aggregated in + UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: | - End time for the aggregate data (UNIX time in seconds). - - - If period is set to "month", valid values range from 3 months ago to the current time. - - If period is set to "day", valid values range from 6 days ago to the current time. - - The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time. + - description: Specify the end month/day of the period to be aggregated in UNIX + time in seconds. in: query name: to required: true @@ -12614,8 +13537,22 @@ paths: - description: | Unit of aggregation. - - month: Aggregate by month. - - day: Aggregate by day. + - `month`: Monthly. + + The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Daily + + The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | in: query name: period required: true @@ -12655,23 +13592,15 @@ paths: required: true schema: type: string - - description: "Start time for the aggregate data (UNIX time in seconds).\n\n- - If period is set to \"month\", valid values range from 3 months ago to the - current time. \n- If period is set to \"day\", valid values range from 6 - days ago to the current time. \n- The actual start time of the - period is 00:00:00 on the first day of the month or day containing the specified - UNIX time.\n" + - description: Specify the start month/day of the period to be aggregated in + UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: | - End time for the aggregate data (UNIX time in seconds). - - - If period is set to "month", valid values range from 3 months ago to the current time. - - If period is set to "day", valid values range from 6 days ago to the current time. - - The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time. + - description: Specify the end month/day of the period to be aggregated in UNIX + time in seconds. in: query name: to required: true @@ -12680,8 +13609,22 @@ paths: - description: | Unit of aggregation. - - month: Aggregate by month. - - day: Aggregate by day. + - `month`: Monthly. + + The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Daily + + The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | in: query name: period required: true @@ -12726,7 +13669,7 @@ paths: - description: | Specify how to obtain the URL to download the Air Data Usage Report CSV. - - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`. + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`. - `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. in: query name: export_mode @@ -12761,7 +13704,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Air Usage Report of All Subscribers. + summary: Export Air Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -12780,22 +13723,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the history of traffic at - the finest granularity. However, while the device is connected to the Soracom - platform, the communication volume is recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12836,22 +13804,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the history of traffic at - the finest granularity. However, while the device is connected to the Soracom - platform, the communication volume is recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12918,7 +13911,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Beam Usage Report of All Subscribers. + summary: Export Beam Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -12935,22 +13928,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -12972,7 +13990,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Beam Usage Report of Subscriber. + summary: Get Beam Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13017,7 +14035,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Funk Usage Report of All Subscribers. + summary: Export Funk Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -13034,22 +14052,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13071,14 +14114,14 @@ paths: security: - api_key: [] api_token: [] - summary: Get Funk Usage Report of Subscriber. + summary: Get Funk Usage Report of Subscriber tags: - Stats x-soracom-cli: - stats funk get /stats/funnel/operators/{operator_id}/export: post: - description: Retrieves a file containing the SORACOM Funnel usage report of + description: Retrieves a file containing the Soracom Funnel usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV. @@ -13116,7 +14159,7 @@ paths: security: - api_key: [] api_token: [] - summary: Export Funnel Usage Report of All Subscribers. + summary: Export Funnel Usage Report of All Subscribers tags: - Stats x-soracom-cli: @@ -13133,22 +14176,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13170,7 +14238,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Funnel Usage Report of Subscriber. + summary: Get Funnel Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13186,7 +14254,8 @@ paths: required: true schema: type: string - - description: Year/Month in 'YYYYMM' format. + - description: Specify the year and month from 18 months before the current + time to the current time in the YYYYMM format. in: query name: year_month required: false @@ -13207,6 +14276,55 @@ paths: - Stats x-soracom-cli: - stats harvest operators get + /stats/harvest/operators/{operator_id}/export: + post: + description: | + Download the Harvest Data Write Count Results Data CSV file that contains the usage report of all the IoT SIMs for the specified operator. + + **Info**: You can also check the Harvest Data write counts of the terminated IoT SIM. + operationId: exportHarvestStats + parameters: + - description: Operator ID. + in: path + name: operator_id + required: true + schema: + type: string + - description: | + Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV. + + - `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [`Files:getExportedFile API`](#!/Files/getExportedFile) to get the URL. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify `async`. + - `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`. + in: query + name: export_mode + required: false + schema: + enum: + - async + - sync + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportRequest' + description: Export time period. + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FileExportResponse' + description: OK. + security: + - api_key: [] + api_token: [] + summary: Export Harvest Data Write Counts Report of all IoT SIMs + tags: + - Stats + x-soracom-cli: + - stats harvest export /stats/harvest/subscribers/{imsi}: get: description: Retrieves the Soracom Harvest usage report for the subscriber specified @@ -13219,22 +14337,47 @@ paths: required: true schema: type: string - - description: Start time for the aggregate data (UNIX time in seconds). + - description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: from required: true schema: type: integer - - description: End time for the aggregate data (UNIX time in seconds). + - description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. in: query name: to required: true schema: type: integer - - description: Unit of aggregation. minutes outputs the usage report at the - finest granularity. However, while the device is connected to the Soracom - platform, the amount of usage will be recorded at approximately 5-minute - intervals. + - description: | + Unit of aggregation. + + - `month`: Aggregate by month. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | in: query name: period required: true @@ -13256,7 +14399,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get Harvest Usage Report of Subscriber. + summary: Get Harvest Usage Report of Subscriber tags: - Stats x-soracom-cli: @@ -13266,7 +14409,8 @@ paths: description: Get Napter audit logs' monthly exported data stats. operationId: getNapterAuditLogsExportedDataStats parameters: - - description: Year/Month in 'YYYYMM' format. + - description: Specify the year and month from 18 months before the current + time to the current time in the YYYYMM format. in: query name: year_month required: false @@ -13324,9 +14468,19 @@ paths: required: false schema: type: string - - description: 'Speed class for filtering the search. Can specify multiple values - delimited by `|`. Valid values include: `s1.minimum`, `s1.slow`, `s1.standard`, - `s1.fast`' + - description: | + Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include: + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` in: query name: speed_class_filter required: false @@ -13519,11 +14673,14 @@ paths: - desc - asc type: string - - description: Maximum number of data entries to retrieve. The default is `10`. + - description: Maximum number of data entries to retrieve (value range is 1 + to 1000). The default is `10`. in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward. @@ -14745,7 +15902,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable: post: description: Disables SIM-Based Routing. - operationId: disableSimBasedRouging + operationId: disableSimBasedRouting parameters: - description: Target VPG ID. in: path @@ -14769,7 +15926,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable: post: description: Enables SIM-Based Routing. - operationId: enableSimBasedRouging + operationId: enableSimBasedRouting parameters: - description: Target VPG ID. in: path @@ -14821,7 +15978,7 @@ paths: security: - api_key: [] api_token: [] - summary: Associate a router's LAN IP address range with its SIM ID. + summary: Associate a router's LAN IP address range with its SIM ID tags: - VirtualPrivateGateway x-soracom-cli: @@ -15159,7 +16316,7 @@ paths: schema: default: "null" type: string - - description: Max number of results in a response + - description: Max number of results in a response. in: query name: limit required: false @@ -15184,7 +16341,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Packet Capture Sessions + summary: List Packet Capture Sessions associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: @@ -15195,7 +16352,7 @@ paths: response: header: x-soracom-next-key post: - description: Create a packet capture sessions associated the VPG. + description: Create a packet capture session associated with the VPG. operationId: createPacketCaptureSession parameters: - description: VPG ID @@ -15217,23 +16374,23 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Created a new packet capture sessions associated with the VPG + description: The packet capture sessions associated with the VPG "400": - description: Failed to create a packet capture sessions associated with - the VPG + description: Failed to create a packet capture session associated with the + VPG "404": description: The specified VPG does not exist. security: - api_key: [] api_token: [] - summary: Create Packet Capture Session + summary: Create a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg create-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}: delete: - description: Delete a packet capture sessions associated the VPG + description: Delete a packet capture session associated with the VPG. operationId: deletePacketCaptureSession parameters: - description: VPG ID @@ -15254,7 +16411,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: Deleted the packet capture session associated with the VPG + description: Deleted the packet capture session "400": description: Failed to delete the packet capture session associated with the VPG @@ -15264,13 +16421,13 @@ paths: security: - api_key: [] api_token: [] - summary: Delete Packet Capture Session + summary: Delete a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg delete-packet-capture-session get: - description: Get a packet capture sessions associated the VPG. + description: Get a packet capture session associated with the VPG. operationId: getPacketCaptureSession parameters: - description: VPG ID @@ -15298,14 +16455,14 @@ paths: security: - api_key: [] api_token: [] - summary: Get Packet Capture Session + summary: Get a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: - vpg get-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop: post: - description: Stop a packet capture session associated with the VPG + description: Stop a packet capture session associated with the VPG. operationId: stopPacketCaptureSession parameters: - description: VPG ID @@ -15334,11 +16491,12 @@ paths: description: The packet capture session associated with the VPG was not found "500": - description: The packet capture session could not be stopped. + description: The packet capture session associated with the VPG could not + be stopped. security: - api_key: [] api_token: [] - summary: Stop Packet Capture Session + summary: Stop a packet capture session associated with the VPG tags: - VirtualPrivateGateway x-soracom-cli: @@ -15471,7 +16629,10 @@ paths: - vpg delete-vpc-peering-connection /volume_discounts: get: - description: Returns a list of contracted long term discounts. + description: | + Returns a list of contracted long term discounts. + + **Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: listVolumeDiscounts responses: "200": @@ -15483,22 +16644,22 @@ paths: security: - api_key: [] api_token: [] - summary: List long term discounts. + summary: List long term discounts tags: - Payment x-soracom-cli: - volume-discounts list post: description: Creates a new long term discount quotation. If the orderId is put - in /confirm, the order is complete. (Currently, long term discount is only - applied to plan-D, plan-K) + in /volume_discounts/{order_id}/confirm, the order is complete (Currently, + long term discount is only applied to plan-D, plan-K). operationId: createVolumeDiscountQuotation requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEstimatedVolumeDiscountRequest' - description: Long term discount contract details + description: Long term discount contract details. required: true responses: "201": @@ -15506,21 +16667,24 @@ paths: application/json: schema: $ref: '#/components/schemas/EstimatedVolumeDiscountModel' - description: Created + description: Created. security: - api_key: [] api_token: [] - summary: Create long term discount quotation. + summary: Create long term discount quotation tags: - Order x-soracom-cli: - volume-discounts create /volume_discounts/{contract_id}: get: - description: Returns contracted long term discount. + description: | + Returns contracted long term discount. + + **Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io). operationId: getVolumeDiscount parameters: - - description: contract_id + - description: Contract ID. in: path name: contract_id required: true @@ -15538,7 +16702,7 @@ paths: security: - api_key: [] api_token: [] - summary: Get long term discount. + summary: Get long term discount tags: - Payment x-soracom-cli: @@ -15549,7 +16713,7 @@ paths: encountered. operationId: confirmVolumeDiscountOrder parameters: - - description: Order ID + - description: Order ID. in: path name: order_id required: true @@ -15565,7 +16729,7 @@ paths: security: - api_key: [] api_token: [] - summary: Confirm long term discount order. + summary: Confirm long term discount order tags: - Order x-soracom-cli: @@ -15584,7 +16748,7 @@ paths: security: - api_key: [] api_token: [] - summary: List available long term discounts. + summary: List available long term discounts tags: - Order x-soracom-cli: @@ -15730,7 +16894,7 @@ components: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: Credentials set. required: true DeviceObjectModel: content: @@ -15761,7 +16925,7 @@ components: application/json: schema: $ref: '#/components/schemas/LagoonPlanChangingRequest' - description: req + description: Request. required: true MFAAuthenticationRequest: content: @@ -15774,7 +16938,7 @@ components: APIAuditLogEntry: properties: apiKind: - description: The kind of the API. + description: The kind of the API (e.g., `/v1/auth`). type: string operatorId: description: The operator ID that called the API. @@ -15791,7 +16955,7 @@ components: format: int64 type: integer userName: - description: The SAM username that called the API, if this parameter is + description: The SAM username that called the API. If this parameter is empty, it means the caller user is the root user. type: string type: object @@ -15840,18 +17004,19 @@ components: ActionConfigProperty: properties: accessKey: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string body: - description: Only for ExecuteWebRequestAction (Optional) + description: Only for ExecuteWebRequestAction (Optional). type: string contentType: - description: Only for ExecuteWebRequestAction + description: Only for ExecuteWebRequestAction. type: string endpoint: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string executionDateTimeConst: + description: The timing of when the action should be performed. enum: - IMMEDIATELY - BEGINNING_OF_NEXT_MONTH @@ -15860,16 +17025,16 @@ components: - NEVER type: string executionOffsetMinutes: - description: Run in the minutes after the timing of executionDateTimeConst + description: Run in the minutes after the timing of executionDateTimeConst. type: string functionName: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string headers: - description: Only for ExecuteWebRequestAction (Optional) + description: Only for ExecuteWebRequestAction (Optional). type: object httpMethod: - description: Only for ExecuteWebRequestAction + description: Only for ExecuteWebRequestAction. enum: - GET - POST @@ -15877,43 +17042,46 @@ components: - DELETE type: string message: - description: Only for SendMailAction, SendMailToOperatorAction + description: Only for SendMailAction, SendMailToOperatorAction. type: string parameter1: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter2: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter3: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter4: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string parameter5: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string secretAccessKey: - description: Only for InvokeAWSLambdaAction + description: Only for InvokeAWSLambdaAction. type: string speedClass: - description: Only for ChangeSpeedClassAction + description: Only for ChangeSpeedClassAction. enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string title: - description: Only for SendMailAction, SendMailToOperatorAction + description: Only for SendMailAction, SendMailToOperatorAction. type: string to: - description: Only for SendMailAction + description: Only for SendMailAction. type: string url: - description: Access URL and parameters. Only for ExecuteWebRequestAction + description: Access URL and parameters. Only for ExecuteWebRequestAction. type: string required: - executionDateTimeConst @@ -16082,32 +17250,32 @@ components: properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string taxIncludedUnitPrice: - description: Tax included unit price + description: Tax included unit price. format: double type: number unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -16117,7 +17285,7 @@ components: AvailableLongTermDiscountResponse: properties: availableLongTermDiscounts: - description: List of available long term discounts + description: List of available long term discounts. items: $ref: '#/components/schemas/AvailableLongTermDiscountModel' type: array @@ -16162,7 +17330,7 @@ components: - EUR type: string updatedTime: - description: Last updated time (unixtime in seconds). + description: Last updated time in UNIX time in seconds. format: int64 type: integer yearMonth: @@ -16185,7 +17353,7 @@ components: - EUR type: string updatedTime: - description: Last updated time (unixtime in seconds). + description: Last updated time in UNIX time in seconds. format: int64 type: integer yearMonth: @@ -16262,7 +17430,8 @@ components: ecid: type: string identifier: - description: optionally link the result to the request + description: An identifier to link a request to the result of that request. + Optional. type: string lac: type: string @@ -16295,17 +17464,18 @@ components: cell locations, and is included as-is in the response. type: string lat: - description: Latitude + description: Latitude. format: double type: number lon: - description: Longitude + description: Longitude. format: double type: number range: - description: Estimate of radio range, in meters. This is an estimate on - how large each cell area is, as a radius around the estimated position - and is based on the observations or a knowledgeable source. + description: Estimate of radio range (radius from the estimated coordinates. + In meters). This is an estimate on how large each cell area is, as a radius + around the estimated position and is based on the observations or a knowledgeable + source. format: int32 type: integer samples: @@ -16370,32 +17540,32 @@ components: CouponResponse: properties: amount: - description: Amount + description: Amount. format: double type: number balance: - description: Balance + description: Balance. format: double type: number billItemName: - description: Item + description: Item. type: string couponCode: - description: Coupon code + description: Coupon code. type: string currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string expiryYearMonth: - description: Expiry month + description: Expiry month. format: yyyyMM type: string orderId: - description: Order ID + description: Order ID. type: string type: object CoverageType: @@ -16420,7 +17590,7 @@ components: CreateEstimatedCouponRequest: properties: amount: - description: Amount + description: Amount. format: double type: number required: @@ -16429,19 +17599,19 @@ components: CreateEstimatedOrderRequest: properties: orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/OrderItemModel' type: array preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. format: yyyyMMdd type: string shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingOptions: - description: Shipping options + description: Shipping options. items: oneOf: - $ref: '#/components/schemas/ShippingOptionOfNekopos' @@ -16452,25 +17622,25 @@ components: properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -16514,6 +17684,8 @@ components: type: object CreateGroupRequest: properties: + configuration: + $ref: '#/components/schemas/GroupConfiguration' tags: $ref: '#/components/schemas/TagSet' type: object @@ -16522,7 +17694,7 @@ components: description: type: string permission: - description: Permission as JSON + description: Permission as JSON. type: string required: - permission @@ -16631,14 +17803,39 @@ components: type: integer type: enum: + - api-token-credentials - aws-credentials + - aws-iam-role-credentials - azure-credentials + - azureIoT-credentials + - esrij-credentials + - google-service-account-json + - googleIoT-credentials + - infoteria-platio-credentials + - kii-thingif-credentials + - landlog-credentials + - mmcloud-credentials + - mockmock-datarecorder-credentials + - motionboard-credentials + - optim-cloud-IoT-OS-credentials + - private-key-pem - psk + - pubnub-credentials + - sensorcorpus-credentials + - username-password-credentials + - watsonIoT-credentials - x509 type: string updateDateTime: format: int64 type: integer + required: + - createDateTime + - credentials + - credentialsId + - lastUsedDateTime + - type + - updateDateTime type: object CreditCard: properties: @@ -16786,11 +17983,14 @@ components: DiagnosticRequest: properties: from: - description: Start time for diagnostic (unixtime milliseconds) + description: Start time for diagnostic (UNIX time in milliseconds). format: int64 type: integer resourceId: - description: resourceId according to resourceType + description: | + Identifier according to resourceType. + + - If resourceType is `sim`, specify the SIM ID. type: string resourceType: enum: @@ -16801,7 +18001,7 @@ components: - Air type: string to: - description: End time for diagnostic (unixtime milliseconds) + description: End time for diagnostic (UNIX time in milliseconds). format: int64 type: integer required: @@ -16814,7 +18014,7 @@ components: diagnosticId: type: string from: - description: Start time for diagnostic (unixtime milliseconds) + description: Start time for diagnostic (UNIX time in milliseconds). format: int64 type: integer insights: @@ -16824,7 +18024,7 @@ components: type: object type: array resourceId: - description: resourceId according to resourceType + description: Identifier according to resourceType. type: string resourceType: enum: @@ -16841,7 +18041,7 @@ components: - failed type: string to: - description: End time for diagnostic (unixtime milliseconds) + description: End time for diagnostic (UNIX time in milliseconds). format: int64 type: integer type: object @@ -16873,15 +18073,21 @@ components: EmailConfigurationOfBilling: properties: attachInvoicePdfEnabled: - description: If true, an invoice PDF is attached with a monthly billing - notification mail (Global coverage only). + description: | + The setting to decide whether to attach the invoice PDF issued by Soracom to a monthly billing notification mail (Global coverage only). + + - `true`: The invoice will be attached. + - `false`: The invoice will not be attached. type: boolean type: object EmailConfigurationOfNotification: properties: exceedBundleDisabled: - description: If true, disable all notification emails that the traffic volume - is reaching a bundled volume. + description: | + The setting for notifications to the primary email address regarding data usage. For more information, refer to [Disabling Low Data Remaining Notifications](/en/docs/air/data-usage/#disabling-low-data-remaining-notifications). + + - `true`: All notifications to the primary email address regarding data usage will be disabled. + - `false`: All notifications to the primary email address regarding data usage will be enabled. type: boolean type: object EmailsModel: @@ -16904,6 +18110,8 @@ components: properties: totpUri: type: string + required: + - totpUri type: object Error: properties: @@ -16918,29 +18126,29 @@ components: EstimatedCouponModel: properties: amount: - description: Amount + description: Amount. format: double type: number currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string expiryYearMonth: - description: Expiry month + description: Expiry month. format: yyyyMM type: string orderId: - description: Order ID + description: Order ID. type: string taxAmount: - description: Tax amount + description: Tax amount. format: double type: number totalAmount: - description: Total amount + description: Total amount. format: double type: number type: object @@ -16949,11 +18157,11 @@ components: product: $ref: '#/components/schemas/ProductModel' productAmount: - description: Product amount + description: Product amount. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer taxIncludedProductAmount: @@ -16962,94 +18170,94 @@ components: EstimatedOrderModel: properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: oneOf: - $ref: '#/components/schemas/ShippingOptionOfNekopos' - $ref: '#/components/schemas/ShippingOptionOfExpeditedShipping' type: array balanceDue: - description: Balance due + description: Balance due. format: double type: number containsTaxIncludedAmounts: - description: Contains tax included amounts + description: Contains tax included amounts. type: boolean currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string email: - description: Email address + description: Email address. type: string orderChannel: - description: Order channel + description: Order channel. type: string orderId: - description: Order ID + description: Order ID. type: string orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. format: yyyyMMdd type: string purchaseOrderNumber: - description: Purchase order number + description: Purchase order number. type: string shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingCost: - description: Shipping cost + description: Shipping cost. format: double type: number taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxIncludedInShippingCost: - description: Tax included in shipping cost + description: Tax included in shipping cost. format: double type: number taxOnShippingCost: - description: Whether shipping cost is taxable + description: Whether shipping cost is taxable. type: boolean totalAmount: - description: Total amount + description: Total amount. format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object EstimatedVolumeDiscountModel: properties: currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string orderId: - description: Order ID + description: Order ID. type: string taxAmount: - description: Tax amount + description: Tax amount. format: double type: number totalAmount: - description: Total amount + description: Total amount. format: double type: number volumeDiscount: @@ -17165,24 +18373,47 @@ components: ExportRequest: properties: from: - description: Start date and time for the aggregate data (UNIX time in seconds) + description: Specify the start month/day/minute of the period to be aggregated + in UNIX time in seconds. example: 1654009200 format: int64 type: integer period: description: | - Degree of detail of history. + Unit of aggregation. + + - `month`: Aggregate by month. - - `month`: Monthly - - `day`: Daily - - `minutes`: Every minute + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). | + - `day`: Aggregate by day. + + The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | + | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). | + - `minutes`: Aggregate by approximately every 5 minutes. + + The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`. + + | Item | Description | + |-|-| + | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | + | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). | enum: - month - day - minutes type: string to: - description: End date and time of the period covered (UNIX time in seconds) + description: Specify the end month/day/minute of the period to be aggregated + in UNIX time in seconds. example: 1656601200 format: int64 type: integer @@ -17592,35 +18823,54 @@ components: attributes: properties: contractEndingTime: + description: Soracom LTE-M Button powered by AWS expiration date. format: date-time type: string firstClickTimestamp: + description: Date and time of first click on Soracom LTE-M Button powered + by AWS. format: date-time type: string remainingCount: + description: Soracom LTE-M Button powered by AWS remaining clicks. type: integer wimaxBillingStartDate: + description: Start date of billing for Soracom Cloud Camera Services + Cellular Pack. type: string wimaxIccid: + description: ICCID (Integrated Circuit Card ID) of the au IC card included + in the Soracom Cloud Camera Services Cellular Pack. Identifier to + identify the au IC card. type: string wimaxImei: + description: IMEI of the router included in the Soracom Cloud Camera + Services Cellular Pack. type: string type: object createdTime: + description: UNIX time (in milliseconds) that the Gadget API compatible + device was registered. format: int64 type: integer id: + description: ID of the Gadget API compatible device. type: string lastModifiedTime: + description: UNIX time (in milliseconds) that the Gadget API compatible + device information was changed. format: int64 type: integer lastSeen: properties: batteryLevel: + description: Battery level of Soracom LTE-M Button powered by AWS. type: integer clickEventPropagated: type: boolean clickTime: + description: Date and time of click on Soracom LTE-M Button powered + by AWS. format: date-time type: string clickType: @@ -17630,15 +18880,28 @@ components: type: string type: object operatorId: + description: Operator ID with which the Gadget API compatible device is + registered. type: string productId: + description: | + Product ID of the target Gadget API compatible device. + + - `button`: Soracom LTE-M Button powered by AWS. + - `wimax`: Soracom Cloud Camera Services Cellular Pack. enum: - button - wimax type: string serialNumber: + description: Serial Number of the target Gadget API compatible device. type: string status: + description: | + Contract status of the Gadget API compatible device. + + - `active`: In use. + - `terminated`: Cancelled. enum: - active - terminated @@ -17646,12 +18909,20 @@ components: tags: additionalProperties: type: string + description: Tags. type: object terminatedTime: + description: The cancellation date and time of the Gadget API compatible + device. If not cancelled, `null`. format: int64 type: integer terminationEnabled: default: false + description: | + Termination protection for Gadget API compatible device. + + - `true`: OFF (can be cancelled) + - `false`: ON (cannot cancel) type: boolean type: object GadgetRegistrationRequest: @@ -17659,6 +18930,7 @@ components: tags: additionalProperties: type: string + description: Tags. type: object type: object GatePeer: @@ -17685,8 +18957,8 @@ components: default: 86400 description: | New API token expiry duration in seconds. - Default: 86400 [seconds] (24 hours) - Maximum: 172800 [seconds] (48 hours) + Default: 86400 [seconds] (24 hours). + Maximum: 172800 [seconds] (48 hours). maximum: 172800 type: integer type: object @@ -17773,43 +19045,43 @@ components: GetOrderResponse: properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: type: object type: array balanceDue: - description: Balance due + description: Balance due. format: double type: number containsTaxIncludedAmounts: type: boolean currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string email: - description: Email address + description: Email address. type: string orderChannel: - description: Order channel + description: Order channel. type: string orderDateTime: - description: Order date and time (yyyyMMddHHmmss) + description: Order date and time (yyyyMMddHHmmss). format: yyyyMMddHHmmss type: string orderId: - description: Order ID + description: Order ID. type: string orderItemList: - description: Order item list + description: Order item list. items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array orderStatus: - description: Order status + description: Order status. enum: - ordering - ordered @@ -17820,48 +19092,93 @@ components: - cancelled - failed type: string + paymentStatus: + description: | + Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/en-us/articles/360029337031). + + - `lessThanMinimumCharge`: Will be billed in the next month or later. (due to less than minimum charge.) + - `paying`: Payment in progress. + - `paid`: Paid. + - `fail`: Process failed. + - `refunding`: Refund in progress. + - `refunded`: Refunded. + - `refund_fail`: Refund failed. + - `delegating_to_third_party`: Delegating receivables. + - `delegated_to_third_party`: Delegated. + - `charging`: Charging in progress. + - `canceling`: Canceling. + - `cancelled`: Cancelled. + - `cancel_failed`: Failed to cancel. + enum: + - lessThanMinimumCharge + - paying + - paid + - fail + - refunding + - refunded + - refund_fail + - delegating_to_third_party + - delegated_to_third_party + - charging + - canceling + - cancelled + - cancel_failed + type: string preferredDeliveryDate: - description: Preferred delivery date + description: Preferred delivery date. type: string purchaseOrderNumber: - description: Purchase order number + description: Purchase order number. type: string resourceInitialSetting: $ref: '#/components/schemas/ResourceInitialSetting' shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' shippingAddressId: - description: Shipping address ID + description: Shipping address ID. type: string shippingCost: - description: Shipping cost + description: Shipping cost. format: double type: number + shippingDateTime: + description: Shipping date and time (yyyyMMddHHmmss). + example: 20231004123456 + format: yyyyMMddHHmmss + type: string + shippingLabelDetails: + description: Shipping label details. + items: + $ref: '#/components/schemas/ShippingLabelDetail' + type: array shippingLabelNumber: - description: Shipping label number (representative) + description: Shipping label number (representative). + example: 0000-1111-2222 type: string shippingLabelNumbers: - description: Shipping label numbers + description: Shipping label numbers. + example: + - 0000-1111-2222 items: type: string type: array taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxIncludedInShippingCost: - description: Tax included in shipping cost + description: Tax included in shipping cost. format: double type: number taxOnShippingCost: - description: Whether shipping cost is taxable + description: Whether shipping cost is taxable, type: boolean totalAmount: - description: Total amount + description: Total amount. format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object @@ -17958,10 +19275,10 @@ components: phoneNumber: type: string shippingAddressId: - description: ID of shipping address + description: ID of shipping address. type: string shippingArea: - description: shipping area + description: Shipping area. type: string state: type: string @@ -17997,63 +19314,65 @@ components: - SRN (Soracom Resource Name) representing the user of another account who is allowed to switch to this SAM user. - Conditions where switching is allowed. + + For details, please refer to [trust policy syntax](https://users.soracom.io/ja-jp/docs/switch-user/trust-policy/) (Japanese). type: string type: object GetVolumeDiscountResponse: properties: contractDateTime: - description: Contract date time + description: Contract date time. example: yyyyMMddHHmmss type: string contractId: - description: Contract ID + description: Contract ID. type: string contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string endDate: - description: End date + description: End date. example: yyyyMMdd type: string initialCost: - description: Initial cost + description: Initial cost. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string status: - description: Status + description: Status. enum: - active - expired type: string unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE @@ -18063,7 +19382,7 @@ components: Group: properties: configuration: - $ref: '#/components/schemas/Map' + $ref: '#/components/schemas/GroupConfiguration' createdTime: format: int64 type: integer @@ -18077,6 +19396,27 @@ components: tags: $ref: '#/components/schemas/TagSet' type: object + GroupConfiguration: + additionalProperties: + description: | + Keys are one of the following namespaces: + + - SoracomAir + - SoracomBeam + - SoracomEndorse + - SoracomOrbit + - SoracomFunk + - SoracomFunnel + - SoracomHarvest + - SoracomHarvestFiles + - SoracomKrypton + - UnifiedEndpoint + + The values are objects corresponding to their respective namespace. + type: object + description: | + Group configuration. + type: object GroupConfigurationUpdateRequest: properties: key: @@ -18143,8 +19483,8 @@ components: properties: anomalyDetectedTimes: description: Times that possible anomaly behaviors were detected. The format - depends on the timestamp of events relating to the category. (e.g. unixtime - milliseconds for session category) + depends on the timestamp of events relating to the category. (e.g., UNIX + time in milliseconds for session category) items: type: string type: array @@ -18161,7 +19501,7 @@ components: message: type: string referenceUrls: - description: Reference URLs that is related to the insight + description: Reference URLs that is related to the insight. items: additionalProperties: $ref: '#/components/schemas/ReferenceUrl' @@ -18193,10 +19533,10 @@ components: IssueAddEmailTokenRequest: properties: email: - description: Email address to be added + description: Email address to be added. type: string password: - description: Password of the operator + description: Password of the root user. type: string required: - email @@ -18335,8 +19675,8 @@ components: licensePackName: description: | Specify the license packs for which you want to update the number. - - `basicUser`: User License Pack - - `basicDashboard`: Dashboard License Pack + - `basicUser`: User License Pack. + - `basicDashboard`: Dashboard License Pack. enum: - basicUser - basicDashboard @@ -18347,7 +19687,7 @@ components: LagoonMigrationRequest: properties: dashboardIds: - description: A list of dashboard IDs to migrate + description: A list of dashboard IDs to migrate. items: type: string type: array @@ -18462,7 +19802,7 @@ components: ListOrderResponse: properties: orderList: - description: List of confirmed orders + description: List of confirmed orders. items: $ref: '#/components/schemas/GetOrderResponse' type: array @@ -18470,7 +19810,7 @@ components: ListOrderedSubscriberResponse: properties: orderedSubscriberList: - description: List of ordered SIMs + description: List of ordered SIMs. items: $ref: '#/components/schemas/OrderedSubscriber' type: array @@ -18478,7 +19818,7 @@ components: ListPaymentStatementResponse: properties: paymentStatementsList: - description: Payment statements + description: Payment statements. items: $ref: '#/components/schemas/PaymentStatementResponse' type: array @@ -18517,7 +19857,7 @@ components: ListVolumeDiscountResponse: properties: volumeDiscountList: - description: Contracted long term discounts + description: Contracted long term discounts. items: $ref: '#/components/schemas/GetVolumeDiscountResponse' type: array @@ -18682,7 +20022,7 @@ components: MFARevokeRequest: properties: password: - description: Root user's password + description: Root user's password. type: string required: - password @@ -18714,6 +20054,7 @@ components: format: double type: number appliedCouponAmount: + description: Amount of coupon applied. format: double type: number currency: @@ -18725,7 +20066,7 @@ components: type: string paymentStatus: description: | - Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/ja/articles/360029337031) (Japanese). + Latest payment status. For details, please refer to [Payment status of usage charges](https://support.soracom.io/hc/en-us/articles/360029337031). - `lessThanMinimumCharge`: Will be billed in the next month or later. (due to less than minimum charge) - `paying`: Payment in progress @@ -18852,6 +20193,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfEmail' - $ref: '#/components/schemas/OperatorConfigurationOfSupport' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' isModifiable: description: If false, the operator configuration cannot be updated by setOperatorConfigurationNamespace API. @@ -18890,6 +20232,19 @@ components: description: Support tier that will be applied for the next month. If the value is null, the current tier will continue for the next month. type: object + OperatorConfigurationOfUserConsole: + properties: + usageMetricsAcknowledged: + description: This setting is to check if an operator has acknowledged and + had the chance to opt-out of usage metrics collection. Usage metrics includes + information such as page views and performance statistics. + type: boolean + usageMetricsDisabled: + description: The setting whether to disable usage metrics collection for + an operator of the User Console. Usage metrics includes information such + as page views and performance statistics. + type: boolean + type: object OperatorMFAVerifyingResponse: properties: backupCodes: @@ -18900,40 +20255,40 @@ components: OrderItemModel: properties: productCode: - description: Product code + description: Product code. type: string quantity: - description: Quantity + description: Quantity. format: int32 type: integer type: object OrderedSubscriber: properties: bundles: - description: Bundles + description: Bundle. items: type: string type: array deviceSerialNumber: - description: Serial number of Device + description: Serial number of Device. type: string eiccid: - description: eICCID + description: eICCID. type: string iccid: - description: ICCID + description: ICCID. type: string imsi: - description: IMSI + description: IMSI. type: string msisdn: - description: MSISDN + description: MSISDN. type: string serialNumber: - description: Serial number of IoT SIM + description: Serial number of IoT SIM. type: string simId: - description: SIM ID + description: SIM ID. type: string type: object PacketCaptureSession: @@ -18984,10 +20339,10 @@ components: - duration type: object PaymentAmount: - description: Payment amount + description: Payment amount. properties: currency: - description: Currency + description: Currency. enum: - JPY - USD @@ -18998,30 +20353,30 @@ components: subTotalAmount: type: number taxAmount: - description: Tax amount + description: Tax amount. format: double type: number taxFreeSubTotalAmount: - description: Tax free sub total amount + description: Tax free sub total amount. format: double type: number taxRate: type: object taxableSubTotalAmount: - description: Taxable sub total amount + description: Taxable sub total amount. format: double type: number totalAmount: - description: Total amount (tax included) + description: Total amount (tax included). format: double type: number withholdingTaxAmount: - description: Withholding tax amount + description: Withholding tax amount. format: double type: number type: object PaymentDescription: - description: Payment description + description: Payment description. properties: description: type: string @@ -19033,7 +20388,7 @@ components: PaymentStatementResponse: properties: amount: - description: Amount + description: Amount. format: double type: number chargedYearMonths: @@ -19045,28 +20400,27 @@ components: type: string type: array currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string orderId: - description: Order ID. If the payment is not for an order, this field is - omitted. + description: Order ID. If the billing is not an order, this field is omitted. type: string paymentDateTime: - description: Payment date time + description: Payment date time. format: int64 type: integer paymentInstrument: - description: Payment instrument + description: Payment instrument. type: string paymentMethod: - description: Payment method + description: Payment method. type: string paymentStatementId: - description: Payment statement ID + description: Payment statement ID. type: string paymentStatementInfo: description: Payment statement information @@ -19079,14 +20433,13 @@ components: - aws type: string region: - default: eu-central-1 description: | If `infrastructureProvider` is `aws`, it indicates the rendezvous point. - - `ap-northeast-1`: Tokyo (Japan) - - `eu-central-1`: Frankfurt (Germany) - - `us-west-2`: Oregon (USA) - - `ap-southeast-2`: Sydney (Australia) + - `ap-northeast-1`: Tokyo (Japan). The default for Japan coverage. + - `eu-central-1`: Frankfurt (Germany). The default for Global coverage. + - `us-west-2`: Oregon (USA). + - `ap-southeast-2`: Sydney (Australia). enum: - ap-northeast-1 - eu-central-1 @@ -19123,11 +20476,29 @@ components: PortMappingDestination: properties: imsi: - description: The target IMSI of the subscriber. + description: The target IMSI of the subscriber. If `simId` parameter is + specified, this parameter will be ignored. type: string port: description: The port on your device used for access. type: number + service: + description: | + A switch parameter to decide the target for creating a port mapping. This parameter is enabled when the `simId` parameter is specified. + + - `air`: The destination will be a SORACOM Air subscriber which has an online session. + - `arc`: The destination will be a SORACOM Arc subscriber. + + **Warning**: In the default case, i.e. this parameter is missing, an online subscription in a SIM will be a target of the port-mapping creation. If there are multiple online sessions, in other words a SIM has SORACOM Air's online session and SORACOM Arc's online session, it doesn't guarantee which one will be a target for the port mapping creation. We recommend specifying `air` or `arc`. + enum: + - air + - arc + type: string + simId: + description: The target SIM ID of the SIM. It prioritizes this parameter + over `imsi` parameter. If this parameter has been given, it attempts to + create a port mapping according to the `service` parameter. + type: string required: - imsi - port @@ -19178,67 +20549,68 @@ components: PriceByQuantity: properties: minQuantity: - description: Min quantity + description: Min quantity. format: int32 type: integer price: - description: Price + description: Price, format: double type: number taxIncludedPrice: - description: TaxIncluded price + description: Tax Included price. format: double type: number type: object ProductModel: - description: Product + description: Product. properties: campaignCode: - description: Campaign code + description: Campaign code. type: string consignorId: - description: Consignor ID + description: Consignor ID. type: string consignorName: - description: Consignor name + description: Consignor name. type: string count: - description: Count + description: Count. format: double type: number currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string description: - description: Product Description + description: Product Description. type: string maxQuantity: - description: Max quantity + description: Max quantity. format: int32 type: integer price: - description: Price + description: Price, format: double type: number priceByQuantityList: + description: Price List by Quantity. items: $ref: '#/components/schemas/PriceByQuantity' type: array productCode: - description: Product code + description: Product code. type: string productInfoURL: - description: URL of product page + description: URL of product page. type: string productName: - description: Product name + description: Product name. type: string productType: - description: Product type + description: Product type. enum: - sim - lora @@ -19249,18 +20621,18 @@ components: properties: additionalProperties: type: string - description: Properties + description: Properties. type: object regularPrice: - description: Regular price + description: Regular price. format: double type: number taxIncludedPrice: - description: Price + description: Tax Included price. format: double type: number taxIncludedRegularPrice: - description: TaxIncluded regular price + description: Tax included regular price. format: double type: number type: object @@ -19309,29 +20681,16 @@ components: type: string type: object type: object - RegisterOperatorsRequest: - properties: - email: - type: string - password: - description: 'Requirements for password: At least 8 characters (max 100), - a mixture of lowercase (a-z), uppercase (A-Z), number (0-9) letters. You - can use symbols.' - type: string - required: - - email - - password - type: object RegisterPayerInformationModel: properties: companyName: description: Company name type: string department: - description: Department + description: Department. type: string fullName: - description: Full name + description: Full name. type: string type: object RegisterSimRequest: @@ -19351,7 +20710,7 @@ components: groupId: type: string registrationSecret: - description: PUK or PASSCODE for IoT SIM + description: PUK or PASSCODE for IoT SIM. type: string tags: $ref: '#/components/schemas/TagSet' @@ -19364,8 +20723,20 @@ components: simInitialSettings: additionalProperties: $ref: '#/components/schemas/SimInitialSetting' - description: Initial setting of SIMs for each subscription. The key specifies - a subscription. + description: | + Initial setting of SIMs for each subscription. The key specifies a subscription. + + - `plan01s` + - `plan01s-low_data_volume` (plan01s - Low Data Volume) + - `planX3` (planX3 X3-5MB) + - `planP1` + - `plan-D` (plan-D, plan-D D-300MB) + - `plan-K2` (plan-K2 K2-300MB) + - `plan-DU` + - `plan-KM1` + - `plan-K` + - `plan-US` + - `plan-NA1-package` (plan-NA1) example: plan01s: groupId: 00000000-1111-2222-3333-444444444444 @@ -19434,7 +20805,7 @@ components: description: | The type of the resource summary. - - `simsPerStatus`: The number of IoT SIMs per status + - `simsPerStatus`: The number of IoT SIMs per status. example: simsPerStatus type: string type: object @@ -19447,8 +20818,8 @@ components: $ref: '#/components/schemas/ResourceSummaryItemDimension' type: array updatedTime: - description: The last updated time of the resource summary item (unixtime - milliseconds). + description: The last updated time of the resource summary item (UNIX time + in milliseconds). example: 1654007722000 format: int64 type: integer @@ -19474,11 +20845,11 @@ components: The name of the resource summary item value. - if `resourceSummaryType` is `simsPerStatus`: - - `readySims`: The number of IoT SIMs of which status is ready - - `activeSims`: The number of IoT SIMs of which status is active - - `inactiveSims`: The number of IoT SIMs of which status is inactive - - `standbySims`: The number of IoT SIMs of which status is standby - - `suspendedSims`: The number of IoT SIMs of which status is suspended + - `readySims`: The number of IoT SIMs of which status is ready. + - `activeSims`: The number of IoT SIMs of which status is active. + - `inactiveSims`: The number of IoT SIMs of which status is inactive. + - `standbySims`: The number of IoT SIMs of which status is standby. + - `suspendedSims`: The number of IoT SIMs of which status is suspended. example: activeSims type: string value: @@ -19494,7 +20865,7 @@ components: description: type: string permission: - description: Permission as JSON + description: Permission as JSON. type: string roleId: type: string @@ -19570,23 +20941,26 @@ components: - false type: string targetOtaStatus: - description: Only for SimSubscriptionStatusRule + description: Only for SimSubscriptionStatusRule. enum: - started - finished - failed type: string targetSpeedClass: - description: Only for SubscriberSpeedClassAttributeRule, SimSpeedClassAttributeRule + description: Only for SubscriberSpeedClassAttributeRule, SimSpeedClassAttributeRule. enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string targetStatus: - description: Only for SubscriberStatusAttributeRule, SimStatusAttributeRule + description: Only for SubscriberStatusAttributeRule, SimStatusAttributeRule. enum: - ready - active @@ -19708,6 +21082,10 @@ components: SetImeiLockRequest: properties: imei: + description: | + IMEI of the target device. If you want to establish a session even when the IMEI is temporarily not reported, append `|ANONYMOUS` to the IMEI value. + + For example, if the IMEI specified is `123456789012345`, specifying `123456789012345|ANONYMOUS` as the parameter value will allow a session to be established even when the IMEI is temporarily not reported. type: string type: object SetNetworkSetRequest: @@ -19721,11 +21099,12 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfSupport' - $ref: '#/components/schemas/OperatorConfigurationOfEmail' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' expectedVersion: - description: This property is used to avoid update confliction. To use - it, retrieve the version by getOperatorConfigurationNamespace API, then - specify the version here. If the expectedVersion is not specified, the - API does not check an update confliction. + description: This property is used to avoid update confliction. To use it, + retrieve the version by getOperatorConfigurationNamespace API, then specify + the version here. If the expectedVersion is not specified, the API does + not check an update confliction. type: number required: - configuration @@ -19760,7 +21139,7 @@ components: type: string type: object ShippingAddressModel: - description: Shipping address + description: Shipping address. properties: addressLine1: type: string @@ -19793,22 +21172,22 @@ components: - zipCode type: object ShippingCostModel: - description: Shipping cost + description: Shipping cost. properties: appliedShippingOptions: - description: Applied shipping options + description: Applied shipping options. items: type: object type: array currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string shippingArea: - description: (Japan coverage only) Shipping area + description: (Japan coverage only) Shipping area. enum: - hokkaido - kita_tohoku @@ -19824,17 +21203,39 @@ components: - okinawa type: string shippingAreaName: - description: Shipping Area name + description: Shipping Area name. type: string shippingCost: - description: Shipping Cost + description: Shipping Cost. format: double type: number size: - description: Size + description: Size. format: int32 type: integer type: object + ShippingLabelDetail: + properties: + shipmentCompany: + description: Shipment company name. + example: Yamato Transport + type: string + shipmentCompanyUrl: + description: Shipment company URL. + example: http://track.kuronekoyamato.co.jp/english/tracking + type: string + trackingNumber: + description: Tracking number. + example: 0000-1111-2222 + type: string + trackingUrl: + description: Tracking URL with tracking number. + example: https://jizen.kuronekoyamato.co.jp/jizen/servlet/crjz.b.NQ0010?id=0000-1111-2222 + type: string + required: + - shipmentCompany + - trackingNumber + type: object ShippingOptionOfExpeditedShipping: description: Available for United States and Canada operators only. properties: @@ -19850,7 +21251,7 @@ components: description: Specify true to allow use of Nekopos. type: boolean shipmentCompany: - description: Shipment company + description: Shipment company. enum: - yamato_transport type: string @@ -20057,7 +21458,29 @@ components: description: Group ID. type: string speedClass: - description: Speed class. + description: | + Speed class. Specify one of the following. Please specify the speed class that matches the subscription. + + - For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - For plan-US: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - For plan-DU: + - `u1.standard` + - `u1.slow` + - For plan-KM1: + - `t1.standard` + - For virtual SIM/Subscriber: + - `arc.standard` type: string tags: additionalProperties: @@ -20086,6 +21509,31 @@ components: $ref: '#/components/schemas/SimplifiedSubscriber' type: object type: object + SimStatusHistoryResponse: + properties: + applyDateTimeEpochSec: + type: integer + bundles: + items: + type: string + type: array + groupId: + type: string + imsi: + type: string + isPrimary: + type: boolean + primaryImsi: + type: string + simId: + type: string + speedClass: + type: string + status: + type: string + subscription: + type: string + type: object SimplifiedSubscriber: properties: bundles: @@ -20126,6 +21574,178 @@ components: payload: type: string type: object + SoraCamAtomCamSettings: + properties: + logo: + description: | + Display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + motionTagging: + description: | + Display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + nightVision: + description: | + Settings for night vision mode. + + - `on`: Night vision mode. + - `off`: Normal mode. + - `auto`: Auto-switching. + enum: + - "on" + - "off" + - auto + type: string + quality: + description: | + Settings for the live video and cloud recording quality. Note that for cloud recordings, the resolution is 1080p (1920 x 1080 pixels), regardless of the quality setting. + + - `low`: The same quality as selecting "360p" in the ATOM app. + - `medium`: The same quality as selecting "SD" in the ATOM app. + - `high`: The same quality as selecting "HD (1080p)" in the ATOM app. + enum: + - low + - medium + - high + type: string + rotation: + description: | + Settings for rotating the image by 180 degrees. Set to `180` when installing the compatible camera device upside down. + + - `0`: OFF (no rotation). + - `180`: ON (180-degree rotation). + enum: + - 0 + - 180 + type: integer + statusLight: + description: | + Settings for the status light (indicator light that shows the status of the camera). + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + timestamp: + description: | + Display settings for the timestamp shown on the bottom right of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsLogo: + properties: + state: + description: | + Display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsMotionTagging: + properties: + state: + description: | + Display settings for motion tagging. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsNightVision: + properties: + state: + description: | + Settings for night vision mode. + + - `on`: Night vision mode. + - `off`: Normal mode. + - `auto`: Auto-switching. + enum: + - "on" + - "off" + - auto + type: string + type: object + SoraCamAtomCamSettingsQuality: + properties: + state: + description: | + Settings for the live video and cloud recording quality. Note that for cloud recordings, the resolution is 1080p (1920 x 1080 pixels), regardless of the quality setting. + + - `low`: The same quality as selecting "360p" in the ATOM app. + - `medium`: The same quality as selecting "SD" in the ATOM app. + - `high`: The same quality as selecting "HD (1080p)" in the ATOM app. + enum: + - low + - medium + - high + type: string + type: object + SoraCamAtomCamSettingsRotation: + properties: + state: + description: | + Settings for rotating the image by 180 degrees. Set to `180` when installing the compatible camera device upside down. + + - `0`: OFF (no rotation). + - `180`: ON (180-degree rotation). + enum: + - 0 + - 180 + type: integer + type: object + SoraCamAtomCamSettingsStatusLight: + properties: + state: + description: | + Settings for the status light (indicator light that shows the status of the camera). + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsTimestamp: + properties: + state: + description: | + Display settings for the timestamp shown on the bottom right of the captured image. + + - `on` + - `off` + enum: + - "on" + - "off" + type: string + type: object SoraCamDevice: properties: appliedLicenses: @@ -20190,11 +21810,17 @@ components: description: | Properties of the license applied to a compatible camera device. - If `name` is `Cloud Continuous Recording License (x Days)` or `Cloud Motion Detection "Unlimited" Recording License (x Days)`: + If `name` is `Cloud Continuous Recording License (x Days)` or + `Cloud Motion Detection "Unlimited" Recording License (x Days)`: - `storage_life`: Storage life. type: string type: object + SoraCamDeviceName: + properties: + name: + type: string + type: object SoraCamEvent: properties: deviceId: @@ -20384,12 +22010,12 @@ components: SoraCamLicensePackQuantityUpdatingRequest: properties: currentQuantity: - description: Current license quantity of the license pack + description: Current license quantity of the license pack. example: 1 format: int32 type: integer desiredQuantity: - description: Desired license quantity of the license pack + description: Desired license quantity of the license pack. example: 2 format: int32 type: integer @@ -20397,20 +22023,20 @@ components: SoraCamLicensePackResponse: properties: id: - description: ID of the license pack + description: ID of the license pack. example: CR7-SC type: string name: - description: Name of the license pack + description: Name of the license pack. example: Cloud Recording License (7 Days) type: string quantity: - description: Current license quantity of the license pack + description: Current license quantity of the license pack. example: 1 format: int32 type: integer salesChannel: - description: Sales channel of the license pack + description: Sales channel of the license pack. example: SORACOM Inc. type: string type: object @@ -20436,6 +22062,62 @@ components: - When trying to get recorded video, there is no recorded video between the specified `from` and `to`. type: string type: object + SoraCamPowerState: + properties: + powerState: + description: | + Power state of the compatible camera device. + + - `on` + - `sleep` + enum: + - "on" + - sleep + type: string + type: object + SoraCamRecordingsAndEventsList: + properties: + events: + items: + properties: + endTime: + description: Timestamp when the event is ended (unix time in milliseconds). + format: int64 + type: integer + startTime: + description: Timestamp when the event is started (unix time in milliseconds). + format: int64 + type: integer + type: + description: | + Type of the event. + + - `motion`: Motion Alert. + - `sound`: Sound Alert. + - `other`: Others. + enum: + - motion + - sound + - other + type: string + type: object + type: array + records: + items: + properties: + endTime: + description: Timestamp when the recording is ended (unix time in milliseconds). + `endTime` is not included for ongoing recordings. + format: int64 + type: integer + startTime: + description: Timestamp when the recording is started (unix time in + milliseconds). + format: int64 + type: integer + type: object + type: array + type: object SoraCamStreamingVideo: properties: expiryTime: @@ -20862,7 +22544,7 @@ components: type: string type: array type: - description: Notification type + description: Email address type. enum: - primary - recovery @@ -20934,17 +22616,25 @@ components: speedClass: description: | Speed class. Specify one of the following. Please specify the speed class that matches the subscription. - - For plan01s, plan01s - Low Data Volume, planP1, planX3 X3-5MB, plan-D: + + - For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: - `s1.minimum` - `s1.slow` - `s1.standard` - `s1.fast` - `s1.4xfast` - - For plan-KM1: - - `t1.standard` + - For plan-US: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` - For plan-DU: - `u1.standard` - `u1.slow` + - For plan-KM1: + - `t1.standard` - For virtual SIM/Subscriber: - `arc.standard` enum: @@ -20953,9 +22643,10 @@ components: - s1.standard - s1.fast - s1.4xfast - - t1.standard + - s1.8xfast - u1.standard - u1.slow + - t1.standard - arc.standard type: string required: @@ -20994,14 +22685,7 @@ components: VerifyAddEmailTokenRequest: properties: token: - description: Token sent by email - type: string - required: - - token - type: object - VerifyOperatorsRequest: - properties: - token: + description: Token sent by email. type: string required: - token @@ -21132,56 +22816,56 @@ components: type: string type: object VolumeDiscountModel: - description: Long term discount + description: Long term discount. properties: contractTermMonth: default: 12 - description: Contract months + description: Contract months. format: int32 type: integer currency: - description: Currency + description: Currency. enum: - JPY - USD - EUR type: string endDate: - description: End date + description: End date. example: yyyyMMdd type: string initialCost: - description: Initial cost + description: Initial cost. format: double type: number quantity: - description: Quantity + description: Quantity. format: int32 type: integer startDate: - description: Start date + description: Start date. example: yyyyMMdd type: string taxIncludedInitialCost: - description: Tax included initial cost + description: Tax included initial cost. format: double type: number taxIncludedUnitPrice: - description: Tax included unit price + description: Tax included unit price. format: double type: number unitPrice: - description: Unit price + description: Unit price. format: double type: number volumeDiscountPaymentType: - description: Payment type + description: Payment type. enum: - MONTHLY - PREPAYMENT type: string volumeDiscountType: - description: Long term discount type + description: Long term discount type. enum: - SORACOM_AIR_BASIC_CHARGE_V2 - SORACOM_AIR_BASIC_CHARGE diff --git a/soracom/generated/cmd/assets/soracom-api.ja.yaml b/soracom/generated/cmd/assets/soracom-api.ja.yaml index 75f50a7d..16644fd5 100644 --- a/soracom/generated/cmd/assets/soracom-api.ja.yaml +++ b/soracom/generated/cmd/assets/soracom-api.ja.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: description: SORACOM API v1 title: SORACOM API - version: 20230704-081118 + version: 20231114-073703 servers: - description: Japan coverage production API url: https://api.soracom.io/v1 @@ -313,7 +313,7 @@ paths: description: | 過去の確定した利用料金を月ごとに一括で取得します。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBillingHistory responses: "200": @@ -347,7 +347,7 @@ paths: description: | 指定した月の確定した利用料金を取得します。今月 (利用料金が未確定の月) を指定した場合は、速報値を取得します。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBilling parameters: - description: 対象年月 @@ -387,7 +387,7 @@ paths: description: | 指定した月の、日ごとの利用料金を取得します。また、月額で課金される利用料金は取得できません。今月 (利用料金が未確定の月) を指定した場合は、速報値が返されます。 - **Warning**: 取得できる利用料金は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getBillingPerDay parameters: - description: 対象年月 @@ -426,7 +426,7 @@ paths: description: | 過去の [課金詳細情報 CSV](/ja-jp/guides/accounting/check-usage/billing-csv/) を専用ストレージにエクスポートして、ダウンロードするための URL を発行します。 - **Warning**: ダウンロードできる課金詳細情報 CSV は、過去 18 か月までです。それ以前の利用料金が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: exportBilling parameters: - description: 対象年月 @@ -546,38 +546,6 @@ paths: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - - amount: 0.09 - billItemCategory: Beam - billItemName: soracomBeamRequestCharge-inHttp - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - amount: 1.8 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - amount: 1.86 - billItemCategory: Air - billItemName: basicCharge-plan01s-active - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfBillItems' @@ -602,33 +570,6 @@ paths: "200": content: application/json: - example: - - costBreakdownList: - - amount: 0.24 - simId: "1234567890123456780" - - amount: 0.12 - simId: "1234567890123456781" - currency: USD - updatedTime: 1682121600 - yearMonth: "202304" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1680307200 - yearMonth: "202303" - - costBreakdownList: - - amount: 1.8 - simId: "1234567890123456780" - currency: USD - updatedTime: 1677628800 - yearMonth: "202302" - - costBreakdownList: - - amount: 1.86 - simId: "1234567890123456780" - currency: USD - updatedTime: 1675209600 - yearMonth: "202301" schema: items: $ref: '#/components/schemas/BillingSummaryResponseOfSims' @@ -645,7 +586,7 @@ paths: /cell_locations: get: description: | - セル ID などの基地局情報から、その基地局の位置情報（緯度経度）を取得します。 + セル ID などの基地局情報から、その基地局の位置情報 (緯度経度) を取得します。 3G の場合は MCC, MNC, LAC, CID を指定してください。CID がなくてもおおよその位置を取得することができますが、精度は高くありません。 LTE (4G) の場合は MCC, MNC, TAC, ECID を指定してください。 基地局情報から位置情報への変換には外部のオープンなデータベースを利用していますので、情報が存在していなかったり誤っている場合もあります。 @@ -665,49 +606,49 @@ paths: ``` operationId: getCellLocation parameters: - - description: MCC (Mobile Country Code) - 国コード + - description: MCC (Mobile Country Code) - 国コード。 example: 440 in: query name: mcc required: true schema: type: string - - description: MNC (Mobile Network Code) - ネットワークコード + - description: MNC (Mobile Network Code) - ネットワークコード。 example: 10 in: query name: mnc required: true schema: type: string - - description: LAC (Location Area Code) - エリアコード（3G 用） + - description: LAC (Location Area Code) - エリアコード (3G 用)。 example: 195 in: query name: lac required: false schema: type: string - - description: CID (Cell ID) - セル ID（3G 用） + - description: CID (Cell ID) - セル ID (3G 用)。 example: 68485165 in: query name: cid required: false schema: type: string - - description: TAC (Tracking Area Code) - エリアコード（LTE 用） + - description: TAC (Tracking Area Code) - エリアコード (LTE 用)。 example: 5840 in: query name: tac required: false schema: type: string - - description: ECID (Enhanced Cell ID) - セル ID（LTE 用） - `ecid` もしくは `eci` のいずれかを指定してください。（どちらに値を指定しても結果は同一です） + - description: ECID (Enhanced Cell ID) - セル ID (LTE 用) - `ecid` もしくは `eci` のいずれかを指定してください。どちらに値を指定しても結果は同一です。 example: 44668480 in: query name: ecid required: false schema: type: string - - description: ECID (Enhanced Cell ID) - セル ID（LTE 用） - `ecid` もしくは `eci` のいずれかを指定してください。（どちらに値を指定しても結果は同一です） + - description: ECID (Enhanced Cell ID) - セル ID (LTE 用) - `ecid` もしくは `eci` のいずれかを指定してください。どちらに値を指定しても結果は同一です。 example: 44668480 in: query name: eci @@ -729,9 +670,9 @@ paths: updated: 2022-01-01T00:00:00:000Z schema: $ref: '#/components/schemas/CellLocation' - description: 基地局の位置情報 + description: 基地局の位置情報。 "404": - description: 指定された基地局の位置情報が見つからない + description: 指定された基地局の位置情報が見つからない。 security: - api_key: [] api_token: [] @@ -741,7 +682,7 @@ paths: x-soracom-cli: - cell-locations get post: - description: 基地局情報のリストから、それらの基地局の位置情報（緯度経度）のリストを取得します。 3G の場合は MCC, MNC, LAC, + description: 基地局情報のリストから、それらの基地局の位置情報 (緯度経度) のリストを取得します。 3G の場合は MCC, MNC, LAC, CID を指定してください。CID がなくてもおおよその位置を取得することができますが、精度は高くありません。 LTE (4G) の場合は MCC, MNC, TAC, ECID を指定してください。 基地局情報から位置情報への変換には外部のオープンなデータベースを利用していますので、情報が存在していなかったり誤っている場合もあります。 operationId: batchGetCellLocations @@ -763,7 +704,7 @@ paths: items: $ref: '#/components/schemas/CellIdentifier' type: array - description: 基地局情報のリスト + description: 基地局情報のリスト。 required: true responses: "200": @@ -792,7 +733,7 @@ paths: items: $ref: '#/components/schemas/CellLocation' type: array - description: 指定された基地局に対応する位置情報のリスト + description: 指定された基地局に対応する位置情報のリスト。 security: - api_key: [] api_token: [] @@ -821,7 +762,8 @@ paths: x-soracom-cli: - coupons list post: - description: 新規でクーポンの見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。 + description: 新規でクーポンの見積もりの作成を行います。orderId を /coupons/{order_id}/confirm に PUT + すると発注が完了します。 operationId: createCouponQuotation requestBody: content: @@ -925,7 +867,7 @@ paths: description: 認証情報を削除する。 operationId: deleteCredential parameters: - - description: Credentials ID + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -933,9 +875,9 @@ paths: type: string responses: "204": - description: Deleted + description: 認証情報が削除されました。 "404": - description: Not Found + description: 認証情報 ID が見つかりません。 security: - api_key: [] api_token: [] @@ -948,7 +890,7 @@ paths: description: 認証情報を新規作成する。 operationId: createCredential parameters: - - description: credentials_id + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -1002,7 +944,7 @@ paths: $ref: '#/components/examples/MockmockDatarecorderCredentials' schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true responses: "201": @@ -1010,7 +952,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CredentialsModel' - description: Created + description: 認証情報が作成されました。 security: - api_key: [] api_token: [] @@ -1023,7 +965,7 @@ paths: description: 認証情報を更新する。 operationId: updateCredential parameters: - - description: credentials_id + - description: 認証情報 ID。 in: path name: credentials_id required: true @@ -1034,7 +976,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true responses: "200": @@ -1108,11 +1050,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前のページで取得した最後のデータエントリのキー。このパラメータを指定することで次のデータエントリを取得できます。 in: query @@ -2022,11 +1966,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -2232,7 +2178,7 @@ paths: description: 診断結果を取得します。 operationId: getDiagnostic parameters: - - description: 診断リクエストの識別子 + - description: 診断リクエストの識別子。 in: path name: diagnostic_id required: true @@ -2260,7 +2206,7 @@ paths: description: イベントハンドラーの一覧を返す。 operationId: listEventHandlers parameters: - - description: target + - description: 監視対象 (イベントを実行する対象)。 in: query name: target required: false @@ -2305,7 +2251,7 @@ paths: application/json: schema: $ref: '#/components/schemas/EventHandlerModel' - description: Created + description: イベントハンドラーが作成されました。 security: - api_key: [] api_token: [] @@ -2319,7 +2265,7 @@ paths: description: 指定されたイベントハンドラーを削除する。 operationId: deleteEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2329,7 +2275,7 @@ paths: "204": description: OK. "404": - description: EventHandler not found. + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2342,7 +2288,7 @@ paths: description: 指定されたイベントハンドラーの情報を返す。 operationId: getEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2356,7 +2302,7 @@ paths: $ref: '#/components/schemas/EventHandlerModel' description: OK. "404": - description: Handler not found. + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2370,7 +2316,7 @@ paths: / SORACOM API で作成する](/ja-jp/docs/event-handler/configure-with-api/) を参照してください。 operationId: updateEventHandler parameters: - - description: handler ID + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2387,7 +2333,7 @@ paths: "200": description: OK. "400": - description: Invalid handlerId. + description: 不正なイベントハンドラー ID が指定されました。 security: - api_key: [] api_token: [] @@ -2398,16 +2344,16 @@ paths: - event-handlers update /event_handlers/{handler_id}/subscribers/{imsi}/ignore: delete: - description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を削除 + description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を削除。 operationId: deleteIgnoreEventHandler parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true schema: type: string - - description: handler_id + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2415,9 +2361,9 @@ paths: type: string responses: "204": - description: OK + description: OK. "404": - description: not found + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2427,16 +2373,16 @@ paths: x-soracom-cli: - event-handlers unignore post: - description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を追加 + description: 指定の IMSI に対して、指定のイベントハンドラーを無視する設定を追加。 operationId: setIgnoreEventHandler parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true schema: type: string - - description: handler_id + - description: イベントハンドラー ID。 in: path name: handler_id required: true @@ -2444,7 +2390,7 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -2458,7 +2404,7 @@ paths: description: 対象 IMSI に紐づくイベントハンドラーのリストを返す。 operationId: listEventHandlersBySubscriber parameters: - - description: imsi + - description: IMSI。 in: path name: imsi required: true @@ -2474,7 +2420,7 @@ paths: type: array description: OK. "404": - description: not found + description: イベントハンドラーが見つかりません。 security: - api_key: [] api_token: [] @@ -2631,11 +2577,20 @@ paths: type: string responses: "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FileEntry' description: 指定されたファイルのメタデータ + headers: + Content-Length: + description: ファイルのサイズ（バイト） + schema: + type: integer + Content-Type: + description: ファイルの Content-Type + schema: + type: string + ETag: + description: ファイルのバージョンを表す識別子 + schema: + type: string "404": description: 指定されたファイルが見つからない security: @@ -2830,10 +2785,10 @@ paths: operationId: listGadgets parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 取得対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: query name: product_id required: false @@ -2856,10 +2811,10 @@ paths: schema: type: string - description: | - タグの値の検索条件 + タグの値の検索条件。 - - `exact`: 完全一致 - - `prefix`: 前方一致 + - `exact`: 完全一致。 + - `prefix`: 前方一致。 in: query name: tag_value_match_mode required: false @@ -2869,7 +2824,7 @@ paths: - exact - prefix type: string - - description: 取得する Gadget API 対応デバイスのデータの件数 (上限) + - description: 取得する Gadget API 対応デバイスのデータの件数 (上限)。 in: query name: limit required: false @@ -2915,7 +2870,7 @@ paths: items: $ref: '#/components/schemas/Gadget' type: array - description: 条件に一致する Gadget API 対応デバイスのデータのリスト + description: 条件に一致する Gadget API 対応デバイスのデータのリスト。 security: - api_key: [] api_token: [] @@ -2935,10 +2890,10 @@ paths: operationId: getGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -2947,7 +2902,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -2980,9 +2935,9 @@ paths: terminationEnabled: false schema: $ref: '#/components/schemas/Gadget' - description: 指定された Gadget API 対応デバイスの詳細情報 + description: 指定された Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -2997,10 +2952,10 @@ paths: operationId: disableTerminationOnGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3009,7 +2964,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3021,9 +2976,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3038,10 +2993,10 @@ paths: operationId: enableTerminationOnGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3050,7 +3005,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3062,9 +3017,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3075,14 +3030,14 @@ paths: - gadgets enable-termination /gadgets/{product_id}/{serial_number}/register: post: - description: Gadget API 対応デバイスを登録する + description: Gadget API 対応デバイスを登録する。 operationId: registerGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3091,7 +3046,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3102,7 +3057,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GadgetRegistrationRequest' - description: Gadget の登録リクエスト + description: Gadget の登録リクエスト。 required: true responses: "200": @@ -3110,9 +3065,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: Gadget API 対応デバイスが正しく登録されました + description: Gadget API 対応デバイスが正しく登録されました。 "404": - description: 指定された Gadget API 対応デバイスが存在しません + description: 指定された Gadget API 対応デバイスが存在しません。 security: - api_key: [] api_token: [] @@ -3127,10 +3082,10 @@ paths: operationId: putGadgetTags parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3139,7 +3094,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3152,7 +3107,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -3160,9 +3115,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3177,10 +3132,10 @@ paths: operationId: deleteGadgetTag parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3189,14 +3144,14 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -3204,9 +3159,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された Gadget API 対応デバイスあるいはタグが存在しない + description: 指定された Gadget API 対応デバイスあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -3222,10 +3177,10 @@ paths: operationId: terminateGadget parameters: - description: | - 対象の Gadget API 対応デバイスの種類 + 対象の Gadget API 対応デバイスの種類。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 in: path name: product_id required: true @@ -3234,7 +3189,7 @@ paths: - button - wimax type: string - - description: 対象の Gadget API 対応デバイスのシリアル番号 + - description: 対象の Gadget API 対応デバイスのシリアル番号。 in: path name: serial_number required: true @@ -3246,9 +3201,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Gadget' - description: 更新後の Gadget API 対応デバイスの詳細情報 + description: 更新後の Gadget API 対応デバイスの詳細情報。 "404": - description: 指定された Gadget API 対応デバイスが存在しない + description: 指定された Gadget API 対応デバイスが存在しない。 security: - api_key: [] api_token: [] @@ -3275,7 +3230,7 @@ paths: required: false schema: type: string - - description: タグの文字列 (`tag_value`) に対する検索条件 + - description: タグの文字列 (`tag_value`) に対する検索条件。 in: query name: tag_value_match_mode required: false @@ -3285,7 +3240,7 @@ paths: - exact - prefix type: string - - description: レスポンス 1 ページあたりの最大数 + - description: レスポンス 1 ページあたりの最大数。 in: query name: limit required: false @@ -3305,7 +3260,7 @@ paths: items: $ref: '#/components/schemas/Group' type: array - description: Group の一覧 + description: Group の一覧。 security: - api_key: [] api_token: [] @@ -3320,19 +3275,47 @@ paths: response: header: x-soracom-next-key post: - description: Group を新規作成する + description: Group を新規作成する。 operationId: createGroup requestBody: content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + tags: + name: Group name schema: $ref: '#/components/schemas/CreateGroupRequest' - description: グループに付けるタグ + description: グループに付けるタグと、グループの設定。 required: true responses: "201": content: application/json: + example: + configuration: + SoracomAir: + metadata: + enabled: true + SoracomHarvest: + enabled: true + SoracomHarvestFiles: + enabled: true + createdAt: 1698796800000 + createdTime: 1698796800000 + groupId: 12345678-abcd-9012-efab-345678901234 + lastModifiedAt: 1698796800000 + lastModifiedTime: 1698796800000 + operatorId: OP0012345678 + tags: + name: Group name schema: $ref: '#/components/schemas/Group' description: Created @@ -3346,10 +3329,10 @@ paths: - groups create /groups/{group_id}: delete: - description: Group ID で指定された Group を削除する + description: Group ID で指定された Group を削除する。 operationId: deleteGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3357,22 +3340,22 @@ paths: type: string responses: "204": - description: 指定された Group を削除完了 + description: 指定された Group を削除完了。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] - summary: Delete Group + summary: グループを削除する tags: - Group x-soracom-cli: - groups delete get: - description: Group ID で指定された Group を返す + description: Group ID で指定された Group を返す。 operationId: getGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3384,9 +3367,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 指定された Group + description: 指定された Group。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] @@ -3397,16 +3380,16 @@ paths: - groups get /groups/{group_id}/configuration/{namespace}: delete: - description: 指定された Group のネームスペースを削除 + description: 指定された Group のネームスペースを削除。 operationId: deleteConfigurationNamespace parameters: - - description: 対象の Group + - description: 対象の Group。 in: path name: group_id required: true schema: type: string - - description: 削除対象のネームスペース + - description: 削除対象のネームスペース。 in: path name: namespace required: true @@ -3415,6 +3398,7 @@ paths: - SoracomAir - SoracomBeam - SoracomEndorse + - SoracomOrbit - SoracomFunk - SoracomFunnel - SoracomHarvest @@ -3424,11 +3408,11 @@ paths: type: string responses: "204": - description: 指定されたネームスペースの削除完了 + description: 指定されたネームスペースの削除完了。 "400": - description: 指定されたネームスペースが存在しない + description: 指定されたネームスペースが存在しない。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3438,7 +3422,7 @@ paths: x-soracom-cli: - groups delete-config-namespace put: - description: 指定された Group のパラメータを追加・更新 + description: 指定された Group のパラメータを追加・更新。 operationId: putConfigurationParameters parameters: - description: 対象の Group の ID。[`Group:listGroups API`](#/Group/listGroups) で取得できます。 @@ -3447,7 +3431,7 @@ paths: required: true schema: type: string - - description: 対象の Configuration + - description: 対象の Configuration。 in: path name: namespace required: true @@ -3516,9 +3500,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 更新後の Group + description: 更新後の Group。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3529,16 +3513,16 @@ paths: - groups put-config /groups/{group_id}/configuration/{namespace}/{name}: delete: - description: 指定された Group のパラメータを削除 + description: 指定された Group のパラメータを削除。 operationId: deleteConfigurationParameter parameters: - - description: 対象の Group + - description: 対象の Group。 in: path name: group_id required: true schema: type: string - - description: 対象のパラメータのネームスペース + - description: 対象のパラメータのネームスペース。 in: path name: namespace required: true @@ -3554,8 +3538,8 @@ paths: - SoracomKrypton - UnifiedEndpoint type: string - - description: 削除対象のパラメータ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら - encodeURIComponent() したものを指定する） + - description: 削除対象のパラメータ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript + なら encodeURIComponent() したものを指定する)。 in: path name: name required: true @@ -3563,9 +3547,9 @@ paths: type: string responses: "204": - description: 指定されたパラメータの削除完了 + description: 指定されたパラメータの削除完了。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3576,16 +3560,16 @@ paths: - groups delete-config /groups/{group_id}/subscribers: get: - description: Group ID で指定された Group に属する Subscriber の一覧を返す + description: Group ID で指定された Group に属する Subscriber の一覧を返す。 operationId: listSubscribersInGroup parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true schema: type: string - - description: レスポンス 1 ページあたりの最大数 + - description: レスポンス 1 ページあたりの最大数。 in: query name: limit required: false @@ -3602,10 +3586,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Group' - description: 指定された Group + items: + $ref: '#/components/schemas/Sim' + type: array + description: 指定された Group。 "404": - description: 指定された Group は存在しない + description: 指定された Group は存在しない。 security: - api_key: [] api_token: [] @@ -3622,10 +3608,10 @@ paths: header: x-soracom-next-key /groups/{group_id}/tags: put: - description: 指定された Configuration Group のタグを追加・更新 + description: 指定された Configuration Group のタグを追加・更新。 operationId: putGroupTags parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true @@ -3638,7 +3624,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 更新対象のタグの配列 + description: 更新対象のタグの配列。 required: true responses: "200": @@ -3646,9 +3632,9 @@ paths: application/json: schema: $ref: '#/components/schemas/Group' - description: 更新後の Group + description: 更新後の Group。 "404": - description: 指定された Group が存在しない + description: 指定された Group が存在しない。 security: - api_key: [] api_token: [] @@ -3660,17 +3646,17 @@ paths: - groups put-tags /groups/{group_id}/tags/{tag_name}: delete: - description: 指定された Group のタグを削除 + description: 指定された Group のタグを削除。 operationId: deleteGroupTag parameters: - - description: 対象の Group の ID + - description: 対象の Group の ID。 in: path name: group_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -3678,9 +3664,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定されたグループあるいはタグが存在しない + description: 指定されたグループあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -3698,7 +3684,7 @@ paths: **Warning**: この API では、SORACOM Lagoon 3 の Dashboard の権限は更新できません。 operationId: updateLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: 対象の Dashboard の ID。 in: path name: dashboard_id required: true @@ -3718,15 +3704,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonDashboardPermissionsUpdatingRequest' - description: req + description: リクエスト。 required: true responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Unauthorized operation + description: 許可されていません。 security: - api_key: [] api_token: [] @@ -3743,7 +3729,7 @@ paths: **Warning**: この API では、SORACOM Lagoon 3 の Dashboard の権限は初期化できません。 operationId: initializeLagoonDashboardPermissions parameters: - - description: dashboard_id + - description: 対象の Dashboard の ID。 in: path name: dashboard_id required: true @@ -3760,11 +3746,11 @@ paths: type: boolean responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Unauthorized operation + description: 許可されていません。 security: - api_key: [] api_token: [] @@ -3797,9 +3783,9 @@ paths: items: $ref: '#/components/schemas/LagoonDashboardPermissionsResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3827,9 +3813,9 @@ paths: application/json: schema: type: string - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3840,7 +3826,7 @@ paths: - lagoon get-image-link /lagoon/license_packs: get: - description: SORACOM Lagoon のライセンスパックのステータスを取得します + description: SORACOM Lagoon のライセンスパックのステータスを取得します。 operationId: listLagoonLicensePackStatus responses: "200": @@ -3850,9 +3836,9 @@ paths: items: $ref: '#/components/schemas/LagoonLicensePackStatusResponse' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3872,15 +3858,15 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonLicensePacksUpdatingRequest' - description: req + description: リクエスト。 required: true responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator Not Found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -3897,7 +3883,7 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "200": - description: OK. The response body contains the Lagoon migration information. + description: SORACOM Lagoon のバージョン移行に関連する情報。 security: - api_key: [] api_token: [] @@ -3914,11 +3900,11 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonMigrationRequest' - description: req + description: リクエスト。 required: true responses: "200": - description: OK. It has finished the Lagoon migration. + description: SORACOM Lagoon のバージョン移行が完了しました。 security: - api_key: [] api_token: [] @@ -3938,11 +3924,11 @@ paths: $ref: '#/components/requestBodies/LagoonPlanChangingRequest' responses: "204": - description: Updated + description: 更新されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator Not Found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -3963,7 +3949,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationRequest' - description: request + description: リクエスト。 required: true responses: "201": @@ -3971,9 +3957,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonRegistrationResponse' - description: Registered + description: 利用が開始されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -3991,11 +3977,11 @@ paths: operationId: terminateLagoon responses: "204": - description: Terminated + description: 解約されました。 "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator not found + description: オペレーターが見つかりません。 security: - api_key: [] api_token: [] @@ -4025,9 +4011,9 @@ paths: items: $ref: '#/components/schemas/LagoonUser' type: array - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4045,7 +4031,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationRequest' - description: request + description: リクエスト。 required: true responses: "201": @@ -4053,9 +4039,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserCreationResponse' - description: Created + description: 作成されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4070,7 +4056,7 @@ paths: description: SORACOM Lagoon のユーザーを削除します。 operationId: deleteLagoonUser parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4078,9 +4064,9 @@ paths: type: integer responses: "204": - description: Deleted + description: 削除されました。 "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4095,7 +4081,7 @@ paths: description: SORACOM Lagoon のユーザーのメールアドレスを変更します。 operationId: updateLagoonUserEmail parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4106,13 +4092,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserEmailUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4127,7 +4113,7 @@ paths: description: SORACOM Lagoon のユーザーのパスワードを変更します。 operationId: updateLagoonUserPassword parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4138,13 +4124,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPasswordUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4159,7 +4145,7 @@ paths: description: SORACOM Lagoon のユーザーの権限を変更します。 operationId: updateLagoonUserPermission parameters: - - description: Target ID of the lagoon user + - description: 対象の SORACOM Lagoon ユーザーの ID。 in: path name: lagoon_user_id required: true @@ -4170,13 +4156,13 @@ paths: application/json: schema: $ref: '#/components/schemas/LagoonUserPermissionUpdatingRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -4192,7 +4178,7 @@ paths: 条件に合うログエントリのリストを返す。ログエントリの総数が 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: getLogs parameters: - - description: ログ取得対象のリソースのタイプ + - description: ログ取得対象のリソースのタイプ。 in: query name: resource_type required: false @@ -4202,13 +4188,13 @@ paths: - EventHandler - VirtualPrivateGateway type: string - - description: ログ取得対象のリソースの ID + - description: ログ取得対象のリソースの ID。 in: query name: resource_id required: false schema: type: string - - description: ログエントリをフィルタするためのサービス名 + - description: ログエントリをフィルタするためのサービス名。 in: query name: service required: false @@ -4223,19 +4209,19 @@ paths: - Funnel - Gate type: string - - description: ログ取得対象の期間の始まり (unixtime) + - description: ログ取得対象の期間の始まり (UNIX 時間 (ミリ秒))。 in: query name: from required: false schema: type: integer - - description: ログ取得対象の期間の終わり (unixtime) + - description: ログ取得対象の期間の終わり (UNIX 時間 (ミリ秒))。 in: query name: to required: false schema: type: integer - - description: 取得するログエントリ数の上限 + - description: 取得するログエントリ数の上限。 in: query name: limit required: false @@ -4255,7 +4241,7 @@ paths: items: $ref: '#/components/schemas/LogEntry' type: array - description: ログエントリのリスト + description: ログエントリのリスト。 security: - api_key: [] api_token: [] @@ -4394,11 +4380,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -4718,7 +4706,7 @@ paths: 条件に合う LoRAWAN ゲートウェイを取得します。LoRaWAN ゲートウェイが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listLoraGateways parameters: - - description: 検索対象にするタグの名前(完全一致)。 + - description: 検索対象にするタグの名前 (完全一致)。 in: query name: tag_name required: false @@ -4740,7 +4728,7 @@ paths: - exact - prefix type: string - - description: 一度に取得する LoRaWAN ゲートウェイの数の上限 + - description: 一度に取得する LoRaWAN ゲートウェイの数の上限。 in: query name: limit required: false @@ -4761,7 +4749,7 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: LoRaWAN ゲートウェイのリスト + description: LoRaWAN ゲートウェイのリスト。 security: - api_key: [] api_token: [] @@ -4792,9 +4780,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 指定された LoRaWAN ゲートウェイの詳細情報 + description: 指定された LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4805,10 +4793,10 @@ paths: - lora-gateways get /lora_gateways/{gateway_id}/disable_termination: post: - description: 指定された LoRaWAN ゲートウェイを Terminate 不可能に設定する + description: 指定された LoRaWAN ゲートウェイを Terminate 不可能に設定する。 operationId: disableTerminationOnLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4820,9 +4808,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4833,10 +4821,10 @@ paths: - lora-gateways disable-termination /lora_gateways/{gateway_id}/enable_termination: post: - description: 指定された LoRaWAN ゲートウェイを Terminate 可能に設定する + description: 指定された LoRaWAN ゲートウェイを Terminate 可能に設定する。 operationId: enableTerminationOnLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4848,9 +4836,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4861,10 +4849,10 @@ paths: - lora-gateways enable-termination /lora_gateways/{gateway_id}/set_network_set: post: - description: 指定された LoRaWAN ゲートウェイの Network Set ID を指定あるいは上書き変更 + description: 指定された LoRaWAN ゲートウェイの Network Set ID を指定あるいは上書き変更。 operationId: setLoraNetworkSet parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4875,16 +4863,16 @@ paths: text/plain: schema: $ref: '#/components/schemas/SetNetworkSetRequest' - description: LoRaWAN ネットワーク ID + description: LoRaWAN ネットワーク ID。 responses: "200": content: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4895,10 +4883,10 @@ paths: - lora-gateways set-network-set /lora_gateways/{gateway_id}/tags: put: - description: 指定された LoRaWAN ゲートウェイのタグを追加・更新 + description: 指定された LoRaWAN ゲートウェイのタグを追加・更新。 operationId: putLoraGatewayTags parameters: - - description: 対象の LoRaWAN デバイスの ID + - description: 対象の LoRaWAN デバイスの ID。 in: path name: gateway_id required: true @@ -4911,7 +4899,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -4919,9 +4907,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4932,17 +4920,17 @@ paths: - lora-gateways put-tags /lora_gateways/{gateway_id}/tags/{tag_name}: delete: - description: 指定された LoRaWAN ゲートウェイのタグを削除 + description: 指定された LoRaWAN ゲートウェイのタグを削除。 operationId: deleteLoraGatewayTag parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -4950,9 +4938,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された LoRaWAN ゲートウェイあるいはタグが存在しない + description: 指定された LoRaWAN ゲートウェイあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -4963,10 +4951,10 @@ paths: - lora-gateways delete-tag /lora_gateways/{gateway_id}/terminate: post: - description: 指定された LoRaWAN ゲートウェイを Terminate + description: 指定された LoRaWAN ゲートウェイを Terminate。 operationId: terminateLoraGateway parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -4978,9 +4966,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -4991,10 +4979,10 @@ paths: - lora-gateways terminate /lora_gateways/{gateway_id}/unset_network_set: post: - description: 指定された LoRaWAN ゲートウェイの Network Set ID を削除 + description: 指定された LoRaWAN ゲートウェイの Network Set ID を削除。 operationId: unsetLoraNetworkSet parameters: - - description: 対象の LoRaWAN ゲートウェイの ID + - description: 対象の LoRaWAN ゲートウェイの ID。 in: path name: gateway_id required: true @@ -5006,9 +4994,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraGateway' - description: 更新後の LoRaWAN ゲートウェイの詳細情報 + description: 更新後の LoRaWAN ゲートウェイの詳細情報。 "404": - description: 指定された LoRaWAN ゲートウェイが存在しない + description: 指定された LoRaWAN ゲートウェイが存在しない。 security: - api_key: [] api_token: [] @@ -5023,7 +5011,7 @@ paths: 条件に合う LoRAWAN ネットワークを取得します。LoRaWAN ネットワークが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listLoraNetworkSets parameters: - - description: 検索対象にするタグの名前(完全一致)。 + - description: 検索対象にするタグの名前 (完全一致)。 in: query name: tag_name required: false @@ -5045,7 +5033,7 @@ paths: - exact - prefix type: string - - description: 一度に取得する LoRaWAN ネットワークの数の上限 + - description: 一度に取得する LoRaWAN ネットワークの数の上限。 in: query name: limit required: false @@ -5066,7 +5054,7 @@ paths: items: $ref: '#/components/schemas/LoraNetworkSet' type: array - description: LoRaWAN ネットワークのリスト + description: LoRaWAN ネットワークのリスト。 security: - api_key: [] api_token: [] @@ -5081,14 +5069,14 @@ paths: response: header: x-soracom-next-key post: - description: LoRaWAN ネットワークを作成する + description: LoRaWAN ネットワークを作成する。 operationId: createLoraNetworkSet requestBody: content: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: タグなど作成対象の LoRaWAN ネットワークに設定する付加情報 + description: タグなど作成対象の LoRaWAN ネットワークに設定する付加情報。 required: true responses: "201": @@ -5096,7 +5084,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: LoRaWAN ネットワークの作成に成功. + description: LoRaWAN ネットワークの作成に成功。 security: - api_key: [] api_token: [] @@ -5107,10 +5095,10 @@ paths: - lora-network-sets create /lora_network_sets/{ns_id}: delete: - description: 指定された LoRaWAN ネットワークを削除する + description: 指定された LoRaWAN ネットワークを削除する。 operationId: deleteLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5118,9 +5106,9 @@ paths: type: string responses: "204": - description: 削除に成功 + description: 削除に成功。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5130,10 +5118,10 @@ paths: x-soracom-cli: - lora-network-sets delete get: - description: 指定された LoRaWAN ネットワークの情報を返す + description: 指定された LoRaWAN ネットワークの情報を返す。 operationId: getLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5145,9 +5133,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: LoRaWAN ネットワークの詳細情報を取得完了 + description: LoRaWAN ネットワークの詳細情報を取得完了。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5161,7 +5149,7 @@ paths: description: 別の Operator から LoRaWAN ネットワークが利用できるようにパーミッションを追加する。 operationId: addPermissionToLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5172,7 +5160,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePermissionRequest' - description: 許可された Operator のリストに追加すべき Operator の ID + description: 許可された Operator のリストに追加すべき Operator の ID。 required: true responses: "200": @@ -5180,7 +5168,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 指定された LoRaWAN ネットワークのパーミッションを更新完了 + description: 指定された LoRaWAN ネットワークのパーミッションを更新完了。 security: - api_key: [] api_token: [] @@ -5195,13 +5183,13 @@ paths: 指定された LoRAWAN ネットワークに属する LoRaWAN ゲートウェイを取得します。LoRaWAN ゲートウェイが 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL が、レスポンスの `link` ヘッダーに含まれます。 operationId: listGatewaysInLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true schema: type: string - - description: 一度に取得する LoRaWAN ゲートウェイの数の上限 + - description: 一度に取得する LoRaWAN ゲートウェイの数の上限。 in: query name: limit required: false @@ -5222,9 +5210,9 @@ paths: items: $ref: '#/components/schemas/LoraGateway' type: array - description: LoRaWAN ゲートウェイのリスト + description: LoRaWAN ゲートウェイのリスト。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5240,10 +5228,10 @@ paths: header: x-soracom-next-key /lora_network_sets/{ns_id}/revoke_permission: post: - description: 指定された LoRaWAN ネットワークの別の Operator への利用許可を取り消す + description: 指定された LoRaWAN ネットワークの別の Operator への利用許可を取り消す。 operationId: revokePermissionFromLoraNetworkSet parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5254,7 +5242,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePermissionRequest' - description: 許可された Operator のリストに追加すべき Operator の ID + description: 許可された Operator のリストに追加すべき Operator の ID。 required: true responses: "200": @@ -5262,7 +5250,7 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 指定された LoRaWAN ネットワークのパーミッションを更新完了 + description: 指定された LoRaWAN ネットワークのパーミッションを削除完了。 security: - api_key: [] api_token: [] @@ -5273,10 +5261,10 @@ paths: - lora-network-sets revoke-permission /lora_network_sets/{ns_id}/tags: put: - description: 指定された LoRaWAN ネットワークのタグを追加・更新 + description: 指定された LoRaWAN ネットワークのタグを追加・更新。 operationId: putLoraNetworkSetTags parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true @@ -5289,7 +5277,7 @@ paths: items: $ref: '#/components/schemas/TagUpdateRequest' type: array - description: 追加・更新対象のタグの配列 + description: 追加・更新対象のタグの配列。 required: true responses: "200": @@ -5297,9 +5285,9 @@ paths: application/json: schema: $ref: '#/components/schemas/LoraNetworkSet' - description: 更新後の LoRaWAN ネットワークの詳細情報 + description: 更新後の LoRaWAN ネットワークの詳細情報。 "404": - description: 指定された LoRaWAN ネットワークが存在しない + description: 指定された LoRaWAN ネットワークが存在しない。 security: - api_key: [] api_token: [] @@ -5310,17 +5298,17 @@ paths: - lora-network-sets put-tag /lora_network_sets/{ns_id}/tags/{tag_name}: delete: - description: 指定された LoRaWAN ネットワークのタグを削除 + description: 指定された LoRaWAN ネットワークのタグを削除。 operationId: deleteLoraNetworkSetTag parameters: - - description: 対象の LoRaWAN ネットワークの ID + - description: 対象の LoRaWAN ネットワークの ID。 in: path name: ns_id required: true schema: type: string - - description: 削除対象のタグ名（URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら encodeURIComponent() - したものを指定する） + - description: 削除対象のタグ名 (URL の Path の一部になるので、パーセントエンコーディングを施す。JavaScript なら + encodeURIComponent() したものを指定する)。 in: path name: tag_name required: true @@ -5328,9 +5316,9 @@ paths: type: string responses: "204": - description: 対象のタグの削除が完了 + description: 対象のタグの削除が完了。 "404": - description: 指定された LoRaWAN ネットワークあるいはタグが存在しない + description: 指定された LoRaWAN ネットワークあるいはタグが存在しない。 security: - api_key: [] api_token: [] @@ -5339,36 +5327,12 @@ paths: - LoraNetworkSet x-soracom-cli: - lora-network-sets delete-tag - /operators: - post: - description: Operator の新規登録をリクエストする。パラメータで指定されたメールアドレスに宛てて、Operator 登録確認用のワンタイムトークンを含んだメールが送信される。 - operationId: createOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RegisterOperatorsRequest' - description: email, password - required: true - responses: - "201": - description: Operator が作成された - "400": - description: メールアドレスがすでに登録されているか、パスワードのフォーマットが不正 - security: - - api_key: [] - api_token: [] - summary: オペレーターを新規作成する - tags: - - Operator - x-soracom-cli: - - operator create /operators/{operator_id}: get: description: Operator の情報を返す。 operationId: getOperator parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5382,7 +5346,7 @@ paths: $ref: '#/components/schemas/GetOperatorResponse' description: OK. "400": - description: Invalid Operator Id + description: 誤ったオペレーター ID が指定されました。 security: - api_key: [] api_token: [] @@ -5396,7 +5360,7 @@ paths: description: オペレーターの認証キー一覧を返す。 operationId: listOperatorAuthKeys parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5423,7 +5387,7 @@ paths: description: オペレーターの認証キーを生成する。 operationId: generateOperatorAuthKey parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5449,13 +5413,13 @@ paths: description: オペレーターの認証キーを削除する。 operationId: deleteOperatorAuthKey parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: auth_key_id + - description: 認証キー ID。 in: path name: auth_key_id required: true @@ -5477,7 +5441,7 @@ paths: description: オペレーターの契約者情報 (法人) を返す。 operationId: getCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5499,10 +5463,10 @@ paths: x-soracom-cli: - operator get-company-information post: - description: オペレーターの契約者情報 (法人) を設定する。 + description: オペレーターの契約者情報 (法人) を作成する。 operationId: createCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5513,15 +5477,15 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: オペレーターの契約者情報 (法人)。 required: true responses: "201": - description: Created. + description: 作成されました。 security: - api_key: [] api_token: [] - summary: オペレーターの契約者情報 (法人) を設定する + summary: オペレーターの契約者情報 (法人) を作成する tags: - Operator x-soracom-cli: @@ -5530,7 +5494,7 @@ paths: description: オペレーターの契約者情報 (法人) を更新する。 operationId: updateCompanyInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5541,7 +5505,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CompanyInformationModel' - description: model + description: オペレーターの契約者情報 (法人)。 required: true responses: "200": @@ -5559,25 +5523,23 @@ paths: description: オペレーターに設定された指定のコンフィグレーションを削除します。 operationId: deleteOperatorConfigurationNamespace parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true schema: type: string responses: - "200": - description: OK. "204": - description: Deleted. + description: 削除されました。 "400": - description: Bad request. + description: 不正なリクエストです。 "404": description: コンフィグレーションが存在しません。 security: @@ -5592,13 +5554,13 @@ paths: description: オペレーターに設定された指定のコンフィグレーションを返します。 operationId: getOperatorConfigurationNamespace parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true @@ -5633,7 +5595,7 @@ paths: required: true schema: type: string - - description: コンフィグレーションの種別を示すネームスペース + - description: コンフィグレーションの種別を示すネームスペース。 in: path name: namespace required: true @@ -5669,7 +5631,7 @@ paths: description: Operator のオプション契約を追加する。 operationId: addOperatorContract parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5680,7 +5642,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ContractUpdatingRequest' - description: model + description: モデル。 required: true responses: "200": @@ -5702,13 +5664,13 @@ paths: description: Opearator のオプション契約を解除する。 operationId: deleteOperatorContract parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: contract_name + - description: オプション契約の名前。 in: path name: contract_name required: true @@ -5716,7 +5678,7 @@ paths: type: string responses: "204": - description: No Content. + description: 削除されました。 security: - api_key: [] api_token: [] @@ -5730,13 +5692,13 @@ paths: description: Operator に新規のカバレッジタイプを追加する。 operationId: addCoverageType parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: coverage_type + - description: カバレッジタイプ。 in: path name: coverage_type required: true @@ -5744,7 +5706,7 @@ paths: type: string responses: "201": - description: Created. + description: 追加されました。 security: - api_key: [] api_token: [] @@ -5758,7 +5720,7 @@ paths: description: メールアドレスの一覧を返す。 operationId: listEmails parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5789,13 +5751,13 @@ paths: description: メールアドレスを削除する。 operationId: deleteEmail parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: email_id + - description: メールアドレス ID。 in: path name: email_id required: true @@ -5803,7 +5765,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -5816,13 +5778,13 @@ paths: description: メールアドレスの情報を取得する。 operationId: getEmail parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: email_id + - description: メールアドレス ID。 in: path name: email_id required: true @@ -5848,7 +5810,7 @@ paths: description: オペレーターの契約者情報 (個人) を取得します。 operationId: getIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5870,10 +5832,10 @@ paths: x-soracom-cli: - operator get-individual-information post: - description: オペレーターの契約者情報 (個人) を設定する。 + description: オペレーターの契約者情報 (個人) を作成する。 operationId: createIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5884,15 +5846,15 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: オペレーターの契約者情報 (個人)。 required: true responses: "201": - description: Created. + description: 作成されました。 security: - api_key: [] api_token: [] - summary: オペレーターの契約者情報 (個人) を設定する + summary: オペレーターの契約者情報 (個人) を作成する tags: - Operator x-soracom-cli: @@ -5901,7 +5863,7 @@ paths: description: オペレーターの契約者情報 (個人) を更新する。 operationId: updateIndividualInformation parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5912,7 +5874,7 @@ paths: application/json: schema: $ref: '#/components/schemas/IndividualInformationModel' - description: model + description: オペレーターの契約者情報 (個人)。 required: true responses: "200": @@ -5930,7 +5892,7 @@ paths: description: ルートユーザーの MFA を無効化します。 operationId: revokeMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5960,7 +5922,7 @@ paths: のいずれかです。 operationId: getMFAStatus parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -5972,9 +5934,9 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAStatusOfUseResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -5988,7 +5950,7 @@ paths: MFA OTP を検証する必要があります。 operationId: enableMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6000,9 +5962,9 @@ paths: application/json: schema: $ref: '#/components/schemas/EnableMFAOTPResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -6013,11 +5975,11 @@ paths: - operator enable-mfa /operators/{operator_id}/mfa/verify: post: - description: ルートユーザーの MFA OTP を検証します。 `Operator:enableMFA` を呼んだ後に呼び出す必要があります。この + description: ルートユーザーの MFA OTP を検証します。`Operator:enableMFA` を呼んだ後に呼び出す必要があります。この API で正しく検証が行われるまで、MFA は有効になりません。この API のレスポンスとして返ってくるバックアップコードは必ず保管してください。 operationId: verifyMFA parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6028,7 +5990,7 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAAuthenticationRequest' - description: request + description: リクエスト。 required: true responses: "200": @@ -6036,9 +5998,9 @@ paths: application/json: schema: $ref: '#/components/schemas/OperatorMFAVerifyingResponse' - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 security: - api_key: [] api_token: [] @@ -6063,13 +6025,13 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdatePasswordRequest' - description: current password, new password + description: 現在のパスワードと新しいパスワード。 required: true responses: "200": description: OK. "400": - description: Invalid password. + description: 不正なパスワードです。 security: - api_key: [] api_token: [] @@ -6083,7 +6045,7 @@ paths: description: ロールの一覧を返す。 operationId: listRoles parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6111,13 +6073,13 @@ paths: description: ロールを削除する。 operationId: deleteRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6142,13 +6104,13 @@ paths: description: ロールを取得する。 operationId: getRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6175,13 +6137,13 @@ paths: description: ロールを新しく追加する。 operationId: createRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6192,7 +6154,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: パーミッション。 required: true responses: "200": @@ -6215,13 +6177,13 @@ paths: description: ロールを編集する。 operationId: updateRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6232,11 +6194,11 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateRoleRequest' - description: permission + description: パーミッション。 required: true responses: "200": - description: OK + description: OK. "404": description: ロールが見つかりません。 security: @@ -6252,13 +6214,13 @@ paths: description: ロールに紐づく SAM ユーザーの一覧を取得する。 operationId: listRoleAttachedUsers parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -6288,7 +6250,7 @@ paths: description: 商品発送先の一覧を返します。 operationId: listShippingAddresses parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6313,7 +6275,7 @@ paths: description: 商品発送先を新規登録する。 operationId: createShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6324,7 +6286,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: 商品発送先。 required: true responses: "201": @@ -6346,13 +6308,13 @@ paths: description: 商品発送先を削除する。 operationId: deleteShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6360,7 +6322,7 @@ paths: type: string responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6373,13 +6335,13 @@ paths: description: 商品発送先を返す。 operationId: getShippingAddress parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6404,13 +6366,13 @@ paths: description: 商品発送先を更新する。 operationId: updateShippingAddress parameters: - - description: Operator ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: shipping_address_id + - description: 商品発送先 ID。 in: path name: shipping_address_id required: true @@ -6421,11 +6383,11 @@ paths: application/json: schema: $ref: '#/components/schemas/ShippingAddressModel' - description: model + description: 商品発送先。 required: true responses: "200": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6439,7 +6401,7 @@ paths: description: サポート画面アクセス用のトークンを返す。 operationId: generateSupportToken parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6453,9 +6415,9 @@ paths: $ref: '#/components/schemas/SupportTokenResponse' description: OK. "400": - description: Invalid Operator Id + description: 誤ったオペレーター ID が指定されました。 "403": - description: Invalid token. + description: 不正なトークンです。 security: - api_key: [] api_token: [] @@ -6497,13 +6459,13 @@ paths: description: メールアドレス設定からメールアドレスを削除する。 operationId: deleteSystemNotification parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6515,7 +6477,7 @@ paths: type: string responses: "204": - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6528,13 +6490,13 @@ paths: description: メールアドレス設定を返す。 operationId: getSystemNotification parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6570,7 +6532,7 @@ paths: required: true schema: type: string - - description: system notification type + - description: メールアドレスの種類。 in: path name: type required: true @@ -6586,7 +6548,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetSystemNotificationsRequest' - description: request + description: リクエスト。 required: true responses: "200": @@ -6594,7 +6556,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SystemNotificationsModel' - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -6609,7 +6571,7 @@ paths: API トークンを用いることができる。 operationId: generateAuthToken parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -6620,7 +6582,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GenerateTokenRequest' - description: token timeout seconds + description: API トークンの有効期間 (秒)。 required: true responses: "200": @@ -6634,7 +6596,7 @@ paths: application/json: schema: $ref: '#/components/schemas/APICallError' - description: リクエストに誤りがあるか、指定されたトークンがすでに無効になっている（後者の場合、/auth API で再度認証を行う必要がある） + description: リクエストに誤りがあるか、指定されたトークンがすでに無効になっている (後者の場合、/auth API で再度認証を行う必要がある)。 security: - api_key: [] api_token: [] @@ -6649,7 +6611,7 @@ paths: キーと API トークンを用いて SORACOM API を呼び出すことはできません。 operationId: revokeOperatorAuthTokens parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true @@ -7345,13 +7307,13 @@ paths: description: SAM ユーザーのロールの一覧を取得する。 operationId: listUserRoles parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true @@ -7380,13 +7342,13 @@ paths: description: SAM ユーザーにロールをアタッチする。 operationId: attachRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true @@ -7397,11 +7359,11 @@ paths: application/json: schema: $ref: '#/components/schemas/AttachRoleRequest' - description: role_id + description: ロール ID。 required: true responses: "200": - description: OK + description: OK. "400": description: 指定されたロールはすでにアタッチされているか、あるいは存在しません。 "404": @@ -7419,19 +7381,19 @@ paths: description: SAM ユーザーからロールをデタッチする。 operationId: detachRole parameters: - - description: オペレーター ID + - description: オペレーター ID。 in: path name: operator_id required: true schema: type: string - - description: user_name + - description: SAM ユーザー名。 in: path name: user_name required: true schema: type: string - - description: role_id + - description: ロール ID。 in: path name: role_id required: true @@ -7439,7 +7401,7 @@ paths: type: string responses: "200": - description: OK + description: OK. "404": description: SAM ユーザーまたはロールが存在しません。 security: @@ -7548,7 +7510,7 @@ paths: description: | `operator_id` と `user_name` で指定した SAM ユーザーに設定された信頼ポリシーを更新します。 - **Warning**: 信頼ポリシーで設定したオペレーターおよび SAM ユーザーに、`operator_id` と `user_name` で指定した SAM ユーザーに指定された権限が与えられます。権限によっては、セッション履歴、通信量履歴など、このオペレーターに関する機微な情報を参照できることがあります。 + **Warning**: 信頼ポリシーを設定すると、リクエストボディで指定したルートユーザーまたは SAM ユーザー (元のユーザー) が、`operator_id` と `user_name` で指定した SAM ユーザー(スイッチ先のユーザー) にスイッチできるようになります。元のユーザーがスイッチしたときは、元のユーザーに、スイッチ先のユーザーと同じ権限が与えられ、権限によっては、セッション履歴、通信量履歴など、このオペレーターに関する機微な情報を参照できることがあります。 operationId: updateUserTrustPolicy parameters: - description: オペレーター ID。 @@ -7679,11 +7641,11 @@ paths: application/json: schema: $ref: '#/components/schemas/IssueAddEmailTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": description: メール登録数の最大を超過しました。 security: @@ -7703,11 +7665,11 @@ paths: application/json: schema: $ref: '#/components/schemas/VerifyAddEmailTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. summary: メールアドレス追加用のトークンを検証する tags: - Email @@ -7722,15 +7684,15 @@ paths: application/json: schema: $ref: '#/components/schemas/MFAIssueRevokingTokenRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: OK + description: OK. "400": - description: Bad request + description: 不正なリクエストです。 "404": - description: Operator not found + description: オペレーターが存在しません。 summary: ルートユーザーの MFA を無効化するためのトークンを発行する tags: - Operator @@ -7739,56 +7701,33 @@ paths: /operators/mfa_revoke_token/verify: post: description: MFA を無効化するためのワンタイムトークン、アカウントのメールアドレス、パスワードおよびバックアップコードの組み合わせによって - MFA を無効化します。 + MFA を無効化します。検証に成功すると、MFA が無効化されます。 operationId: verifyMFARevokingToken requestBody: content: application/json: schema: $ref: '#/components/schemas/MFARevokingTokenVerifyRequest' - description: request + description: リクエスト。 required: true responses: "200": - description: Revoked + description: 無効化されました。 "400": - description: Bad request + description: 不正なリクエストです。 "403": - description: Invalid username or password + description: メールアドレスまたはパスワードが誤っています。 summary: ルートユーザーの MFA を無効化するためのトークンを検証して MFA を無効化する tags: - Operator x-soracom-cli: - operator verify-mfa-revoke-token - /operators/verify: - post: - description: Operator 登録の確認を行う。メールで送られてくる確認用ワンタイムトークンをパラメータに含めて呼び出しを行う。 - operationId: verifyOperator - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VerifyOperatorsRequest' - description: token - required: true - responses: - "200": - description: 登録成功 - "400": - description: ワンタイムトークンが不正 - "404": - description: ワンタイムトークンが期限切れ - summary: オペレーター登録を確認する - tags: - - Operator - x-soracom-cli: - - operator verify /orders: get: description: | 発注確定済みの注文履歴の一覧を取得します。 - **Warning**: 取得できる注文履歴は、過去 18 か月までです。それ以前の注文履歴が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listOrders responses: "200": @@ -7806,7 +7745,7 @@ paths: x-soracom-cli: - orders list post: - description: 新規で発注見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。 + description: 新規で発注見積もりの作成を行います。orderId を /orders/{order_id}/confirm に PUT すると発注が完了します。 operationId: createQuotation requestBody: content: @@ -7835,7 +7774,7 @@ paths: description: | 発注確定済みの注文履歴を 1 件だけ取得します。 - **Warning**: 取得できる注文履歴は、過去 18 か月までです。それ以前の注文履歴が必要な場合は、[SORACOM サポート](/ja-jp/docs/support/) に問い合わせてください。 + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getOrder parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7887,7 +7826,10 @@ paths: - orders cancel /orders/{order_id}/confirm: put: - description: 与信を実施し、問題ない場合に発注を確定します。 + description: | + 与信を実施し、問題ない場合に発注を確定します。 + + **Warning**: 確定できる発注は、過去 1 か月までに完了した発注のみです。1 か月を経過した場合は、発注操作をやり直してください。 operationId: confirmOrder parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7909,7 +7851,10 @@ paths: - orders confirm /orders/{order_id}/resource_initial_setting: put: - description: 発注した商品に対して初期設定を指定します。 + description: | + 発注した商品に対して初期設定を指定します。 + + **Warning**: 受け取り確認後の IoT SIM の初期設定は指定できません。 operationId: updateOrderedResourceInitialSetting parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7946,7 +7891,10 @@ paths: - orders resource-initial-setting update /orders/{order_id}/subscribers: get: - description: 発注した IoT SIM の一覧を返します。 + description: | + 発注した IoT SIM の一覧を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listOrderedSubscribers parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -7955,8 +7903,8 @@ paths: required: true schema: type: string - - description: 直前のリクエストで取得したうち、最後の Subscriber の製造番号。レスポンスヘッダの X-Soracom-Next-Key - に含まれる値 + - description: 前ページを取得したときに返された `x-soracom-next-key` ヘッダーに含まれる値。次ページを取得する場合に指定します。詳しくは、[大量のデータを取得する + (ページング)](/ja-jp/tools/api/paging/) を参照してください。 in: query name: last_evaluated_key required: false @@ -7991,7 +7939,10 @@ paths: header: x-soracom-next-key /orders/{order_id}/subscribers/register: post: - description: 発注した IoT SIM をオペレーターに登録します。 + description: | + 発注した IoT SIM をオペレーターに登録します。 + + **Warning**: 登録できる IoT SIM は、過去 18 か月までです。それ以前に発注した IoT SIM を登録する場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: registerOrderedSim parameters: - description: 発注 ID。[`Order:listOrders API`](#/Order/listOrders) を呼び出すと取得できます。 @@ -8017,7 +7968,10 @@ paths: - orders register-subscribers /payment_history/transactions/{payment_transaction_id}: get: - description: 課金処理の結果を返します。 + description: | + 課金処理の結果を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getPaymentTransaction parameters: - description: 課金処理 ID。[Billing:getBillingHistory API](#/Billing/getBillingHistory) @@ -8090,7 +8044,10 @@ paths: - payment-methods reactivate-current /payment_statements: get: - description: 課金明細の一覧を返します。 + description: | + 課金明細の一覧を返します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listPaymentStatements responses: "200": @@ -8109,7 +8066,10 @@ paths: - payment-statements list /payment_statements/{payment_statement_id}/export: post: - description: 課金明細を出力します。 + description: | + 課金明細を出力します。 + + **Warning**: 取得できる情報は、過去 18 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: exportPaymentStatement parameters: - description: 課金明細 ID @@ -8193,7 +8153,7 @@ paths: description: オンデマンドリモートアクセスのリストを返します。 operationId: listPortMappings parameters: - - description: 取得結果のページごとの最大表示件数 + - description: 取得結果のページごとの最大表示件数。 in: query name: limit required: false @@ -8213,7 +8173,7 @@ paths: items: $ref: '#/components/schemas/PortMapping' type: array - description: オンデマンドリモートアクセスのリスト + description: オンデマンドリモートアクセスのリスト。 security: - api_key: [] api_token: [] @@ -8235,7 +8195,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreatePortMappingRequest' - description: 作成するオンデマンドリモートアクセスの設定 + description: 作成するオンデマンドリモートアクセスの設定。 required: true responses: "201": @@ -8243,7 +8203,7 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: オンデマンドリモートアクセスが作成された + description: オンデマンドリモートアクセスが作成された。 security: - api_key: [] api_token: [] @@ -8257,13 +8217,13 @@ paths: description: 指定したオンデマンドリモートアクセスを削除します。 operationId: deletePortMapping parameters: - - description: 対象となるオンデマンドリモートアクセスの IP アドレス + - description: 対象となるオンデマンドリモートアクセスの IP アドレス。 in: path name: ip_address required: true schema: type: string - - description: 対象となるオンデマンドリモートアクセスのポート番号 + - description: 対象となるオンデマンドリモートアクセスのポート番号。 in: path name: port required: true @@ -8271,9 +8231,9 @@ paths: type: string responses: "204": - description: 指定したオンデマンドリモートアクセスの削除を完了した + description: 指定したオンデマンドリモートアクセスの削除を完了した。 "404": - description: 指定したオンデマンドリモートアクセスは存在しない + description: 指定したオンデマンドリモートアクセスは存在しない。 security: - api_key: [] api_token: [] @@ -8287,7 +8247,7 @@ paths: description: Subscriber に紐づくオンデマンドリモートアクセスを取得します。 operationId: listPortMappingsForSubscriber parameters: - - description: 対象の Subscriber の IMSI + - description: 対象の Subscriber の IMSI。 in: path name: imsi required: true @@ -8299,9 +8259,9 @@ paths: application/json: schema: $ref: '#/components/schemas/PortMapping' - description: Subscriber に紐づくオンデマンドリモートアクセスのリスト + description: Subscriber に紐づくオンデマンドリモートアクセスのリスト。 "404": - description: 指定した Subscriber は存在しない + description: 指定した Subscriber は存在しない。 security: - api_key: [] api_token: [] @@ -8314,6 +8274,12 @@ paths: get: description: 購入できる商品一覧を取得します。 operationId: listProducts + parameters: + - in: query + name: campaign_code + required: false + schema: + type: string responses: "200": content: @@ -8335,7 +8301,7 @@ paths: SORACOM Inventory デバイスに対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchDevices parameters: - - description: 検索する SORACOM Inventory デバイスの名前 + - description: 検索する SORACOM Inventory デバイスの名前。 explode: true in: query name: name @@ -8344,7 +8310,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8353,7 +8319,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの ID + - description: 検索する SORACOM Inventory デバイスの ID。 explode: true in: query name: deviceId @@ -8362,7 +8328,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8371,7 +8337,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMSI + - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMSI。 explode: true in: query name: imsi @@ -8380,7 +8346,7 @@ paths: items: type: string type: array - - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMEI + - description: 検索する SORACOM Inventory デバイスの bootstrap 時の IMEI。 explode: true in: query name: imei @@ -8389,7 +8355,7 @@ paths: items: type: string type: array - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8405,7 +8371,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8423,9 +8389,9 @@ paths: items: $ref: '#/components/schemas/Device' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8445,7 +8411,7 @@ paths: Sigfox デバイスに対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchSigfoxDevices parameters: - - description: 検索する Sigfox デバイスの名前 + - description: 検索する Sigfox デバイスの名前。 explode: true in: query name: name @@ -8454,7 +8420,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8463,7 +8429,7 @@ paths: items: type: string type: array - - description: 検索する Sigfox デバイスの ID + - description: 検索する Sigfox デバイスの ID。 explode: true in: query name: deviceId @@ -8472,7 +8438,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8481,7 +8447,7 @@ paths: items: type: string type: array - - description: 検索する Sigfox デバイスの状態 + - description: 検索する Sigfox デバイスの状態。 in: query name: status required: false @@ -8498,7 +8464,7 @@ paths: - banned - standby type: string - - description: 検索する Sigfox デバイスの登録状態 + - description: 検索する Sigfox デバイスの登録状態。 in: query name: registration required: false @@ -8510,7 +8476,7 @@ paths: - success - failed type: string - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8525,7 +8491,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8543,9 +8509,9 @@ paths: items: $ref: '#/components/schemas/SigfoxDevice' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8651,10 +8617,11 @@ paths: type: string type: array - description: | - セッションの状態 - - `NA`: 任意 - - `ONLINE`: オンライン - - `OFFLINE`: オフライン + セッションの状態。 + + - `NA`: 任意。 + - `ONLINE`: オンライン。 + - `OFFLINE`: オフライン。 in: query name: session_status required: false @@ -8666,7 +8633,7 @@ paths: - OFFLINE format: string type: string - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8699,9 +8666,9 @@ paths: items: $ref: '#/components/schemas/Sim' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8718,11 +8685,11 @@ paths: /query/subscribers: get: deprecated: true - description: (非推奨の API です。代わりに `/query/sims` API を利用することを検討してください) Subscriber + description: (非推奨の API です。代わりに `/query/sims` API を利用することを検討してください。) Subscriber をクエリに応じて検索します。部分一致したものを返却します。この API 権限が付与された場合、すべての SIM に対して group も含めた検索/一覧取得を行える権限が与えられます。 operationId: searchSubscribers parameters: - - description: 検索する Subscriber の名前 + - description: 検索する Subscriber の名前。 explode: true in: query name: name @@ -8731,7 +8698,7 @@ paths: items: type: string type: array - - description: 検索するグループの名前 + - description: 検索するグループの名前。 explode: true in: query name: group @@ -8740,7 +8707,7 @@ paths: items: type: string type: array - - description: 検索する IMSI + - description: 検索する IMSI。 explode: true in: query name: imsi @@ -8749,7 +8716,7 @@ paths: items: type: string type: array - - description: 検索する MSISDN + - description: 検索する MSISDN。 explode: true in: query name: msisdn @@ -8758,7 +8725,7 @@ paths: items: type: string type: array - - description: 検索する ICCID + - description: 検索する ICCID。 explode: true in: query name: iccid @@ -8767,7 +8734,7 @@ paths: items: type: string type: array - - description: 検索する製造番号 + - description: 検索する製造番号。 explode: true in: query name: serial_number @@ -8776,7 +8743,7 @@ paths: items: type: string type: array - - description: 検索するタグの値の文字列 + - description: 検索するタグの値の文字列。 explode: true in: query name: tag @@ -8785,7 +8752,7 @@ paths: items: type: string type: array - - description: '検索するサブスクリプション (例: `plan01s`)' + - description: '検索するサブスクリプション (例: `plan01s`)。' explode: true in: query name: subscription @@ -8794,7 +8761,7 @@ paths: items: type: string type: array - - description: '検索するモジュールタイプ (例: `mini`, `virtual`)' + - description: '検索するモジュールタイプ (例: `mini`, `virtual`)。' explode: true in: query name: module_type @@ -8803,7 +8770,7 @@ paths: items: type: string type: array - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8818,7 +8785,7 @@ paths: required: false schema: type: string - - description: 検索の種別 (AND 検索もしくは OR 検索) + - description: 検索の種別 (AND 検索もしくは OR 検索)。 in: query name: search_type required: false @@ -8836,9 +8803,9 @@ paths: items: $ref: '#/components/schemas/Subscriber' type: array - description: 正常に検索結果を返却 + description: 正常に検索結果を返却。 "400": - description: 不正な検索クエリ + description: 不正な検索クエリ。 security: - api_key: [] api_token: [] @@ -8858,21 +8825,21 @@ paths: description: 指定された期間の Subscriber の通信量ランキングを検索して返却します。 operationId: searchSubscriberTrafficVolumeRanking parameters: - - description: 検索期間の始点 (UNIX 時間 (ミリ秒)) + - description: 検索期間の始点 (UNIX 時間 (ミリ秒))。 in: query name: from required: true schema: format: int64 type: integer - - description: 検索期間の終点 (UNIX 時間 (ミリ秒)) + - description: 検索期間の終点 (UNIX 時間 (ミリ秒))。 in: query name: to required: true schema: format: int64 type: integer - - description: 取得する結果の上限数 + - description: 取得する結果の上限数。 in: query name: limit required: false @@ -8881,7 +8848,7 @@ paths: format: int32 maximum: 500 type: integer - - description: ランキングの順序 + - description: ランキングの順序。 in: query name: order required: false @@ -8899,7 +8866,7 @@ paths: items: $ref: '#/components/schemas/TrafficVolumeRanking' type: array - description: OK + description: OK. security: - api_key: [] api_token: [] @@ -8915,9 +8882,9 @@ paths: operationId: getResourceSummary parameters: - description: | - リソースの要約の種別 + リソースの要約の種別。 - - `simsPerStatus`: ステータスごとの IoT SIM の数 + - `simsPerStatus`: ステータスごとの IoT SIM の数。 in: path name: resource_summary_type required: true @@ -8931,9 +8898,9 @@ paths: application/json: schema: $ref: '#/components/schemas/ResourceSummary' - description: リソースの要約を取得しました + description: リソースの要約を取得しました。 "404": - description: 指定のリソースの要約は存在しません + description: 指定のリソースの要約は存在しません。 security: - api_key: [] api_token: [] @@ -9067,11 +9034,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: 前ページで取得した最後のデータエントリのタイムスタンプ。このパラメータを指定することで次のデータエントリ以降のリストを取得できる。 in: query @@ -9645,11 +9614,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | 前のページで取得した最後のデータエントリのキー。この API でのデータエントリーのキーは、`${UNIX 時間 (ミリ秒)}_${IMSI}` です。このパラメータを指定することで次のデータエントリを取得できます。 @@ -9889,7 +9860,7 @@ paths: header: x-soracom-next-key /sims/{sim_id}/packet_capture_sessions: get: - description: 指定した IoT SIM のパケットキャプチャセッションのリストを取得する。 + description: IoT SIM に対するパケットキャプチャセッションのリストを取得する。 operationId: listSimPacketCaptureSessions parameters: - description: 対象の SIM ID @@ -9920,13 +9891,13 @@ paths: items: $ref: '#/components/schemas/PacketCaptureSession' type: array - description: 指定した IoT SIM のパケットキャプチャセッションのリスト + description: IoT SIM に対するパケットキャプチャセッションのリスト "404": description: 指定した IoT SIM が存在しない security: - api_key: [] api_token: [] - summary: IoT SIM のパケットキャプチャセッションのリストを取得する + summary: IoT SIM に対するパケットキャプチャセッションのリストを取得する tags: - Sim x-soracom-cli: @@ -9937,10 +9908,10 @@ paths: response: header: x-soracom-next-key post: - description: 指定した IoT SIM に対するパケットキャプチャセッションを作成する。 + description: IoT SIM に対するパケットキャプチャセッションを作成する。 operationId: createSimPacketCaptureSession parameters: - - description: パケットキャプチャセッションを作成する IoT SIM の ID + - description: 対象の SIM ID in: path name: sim_id required: true @@ -9959,22 +9930,22 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定した IoT SIM に対して作成されたパケットキャプチャセッション + description: IoT SIM に対するパケットキャプチャセッション "400": - description: 指定した IoT SIM に対するパケットキャプチャセッションの作成が失敗した + description: IoT SIM に対するパケットキャプチャセッションの作成が失敗した "404": description: 指定した IoT SIM が存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを作成する + summary: IoT SIM に対するパケットキャプチャセッションを作成する tags: - Sim x-soracom-cli: - sims create-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}: delete: - description: 指定した IoT SIM に対するパケットキャプチャを削除する。 + description: IoT SIM に対するパケットキャプチャセッションを削除する。 operationId: deleteSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -9997,19 +9968,19 @@ paths: $ref: '#/components/schemas/PacketCaptureSession' description: 削除されたパケットキャプチャセッションの情報 "400": - description: 指定されたパケットキャプチャセッションの削除に失敗 + description: IoT SIM に対するパケットキャプチャセッションの削除に失敗 "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを削除する + summary: IoT SIM に対するパケットキャプチャセッションを削除する tags: - Sim x-soracom-cli: - sims delete-packet-capture-session get: - description: 指定した IoT SIM に対するパケットキャプチャセッションを取得する。 + description: IoT SIM に対するパケットキャプチャセッションを取得する。 operationId: getSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -10030,20 +10001,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定されたパケットキャプチャセッション + description: IoT SIM に対するパケットキャプチャセッション "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを取得する + summary: IoT SIM に対するパケットキャプチャセッションを取得する tags: - Sim x-soracom-cli: - sims get-packet-capture-session /sims/{sim_id}/packet_capture_sessions/{session_id}/stop: post: - description: 指定した IoT SIM に対するパケットキャプチャを停止する。 + description: IoT SIM に対するパケットキャプチャセッションを停止する。 operationId: stopSimPacketCaptureSession parameters: - description: 対象の SIM ID @@ -10069,13 +10040,13 @@ paths: description: The packet capture session can be stopped only when its status is CAPTURING "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: IoT SIM に対するパケットキャプチャセッションが存在しない "500": - description: 指定されたパケットキャプチャセッションが停止できなかった + description: IoT SIM に対するパケットキャプチャセッションが停止できなかった security: - api_key: [] api_token: [] - summary: パケットキャプチャを停止する + summary: IoT SIM に対するパケットキャプチャセッションを停止する tags: - Sim x-soracom-cli: @@ -10477,7 +10448,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetImeiLockRequest' - description: IoT SIM に指定する IMEI lock の設定 (オンラインの IoT SIM の現在の IMEI にロックするには + description: IoT SIM に指定する IMEI ロックの設定 (オンラインの IoT SIM の現在の IMEI にロックするには IMEI は指定しなくてもよい) responses: "200": @@ -10531,6 +10502,83 @@ paths: - Sim x-soracom-cli: - sims set-to-standby + /sims/{sim_id}/statuses/history: + get: + description: IoT SIM のステータス操作履歴を取得します。ステータス操作履歴は、どの IMSI、どのサブスクリプションに対して、どのようなステータス操作を行ったかが操作時間とともに記録されています。速度クラスやグループ + ID、IoT SIM のステータスなどが含まれます。ステータス操作履歴が 1 ページに収まらない場合は、同じ条件で次のページを取得するための URL + が、レスポンスの `link` ヘッダーに含まれます。 + operationId: listSimStatusHistory + parameters: + - description: 対象の IoT SIM の SIM ID。 + in: path + name: sim_id + required: true + schema: + type: string + - description: ステータス操作履歴を取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象の IoT SIM の最も古いステータス操作履歴の発生時刻が設定されます。 + in: query + name: from + required: false + schema: + type: integer + - description: ステータス操作履歴を取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false + schema: + type: integer + - description: 前ページで取得した最後のステータス操作履歴のプライマリ IMSI とタイムスタンプ (UNIX 時間 (ミリ秒)) を `@` + で連結した文字列。このパラメータを指定することで次のステータス操作履歴以降のデータを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: ステータス操作履歴のソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + - description: 取得するステータス操作履歴の上限。ただし、返却されるステータス操作履歴の個数は指定された値を下回る可能性があります。 + in: query + name: limit + required: false + schema: + default: 30 + maximum: 100 + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SimStatusHistoryResponse' + type: array + description: IoT SIM のステータス操作履歴。 + "400": + description: 不正なリクエスト。 + "404": + description: 指定した IoT SIM が存在しない。 + security: + - api_key: [] + api_token: [] + summary: IoT SIM のステータス操作履歴を取得する + tags: + - Sim + x-soracom-cli: + - sims list-status-history + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sims/{sim_id}/suspend: post: description: 指定した IoT SIM のステータスを「利用中断中 (suspended)」に変更する。 @@ -10821,7 +10869,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -10859,108 +10907,58 @@ paths: - SoraCam x-soracom-cli: - sora-cam devices get - /sora_cam/devices/{device_id}/events: + /sora_cam/devices/{device_id}/atomcam/settings: get: description: | - `device_id` で指定したソラカメ対応カメラで検出されたイベントの一覧を取得します。 - operationId: listSoraCamDeviceEventsForDevice + ソラカメ対応カメラの各種設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettings parameters: - - description: 対象のソラカメ対応カメラの ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string - - description: 前回の listSoraCamDeviceEventsForDevice リクエストのレスポンスに含まれていた x-soracom-next-key - ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 - in: query - name: last_evaluated_key - required: false - schema: - type: string - - description: 1 回のリクエストで取得するデータ数の最大値。なお、レスポンスには、指定した最大値よりも少ないデータしか含まれないことがあります。 - in: query - name: limit - required: false - schema: - default: 10 - type: integer - - description: イベントを取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラで検出された最も古いイベントの発生時刻が設定されます。 - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: イベントを取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 - in: query - name: to - required: false - schema: - format: int64 - type: integer - - description: | - イベント一覧のソート順。 - - - `desc`: 降順 (対象のソラカメ対応カメラで検出された最新のイベントが先頭) - - `asc`: 昇順 (対象のソラカメ対応カメラで検出された最も古いイベントが先頭) - in: query - name: sort - required: false - schema: - default: desc - enum: - - desc - - asc - type: string responses: "200": content: application/json: example: - - deviceId: 7CDDDEADBEEF - deviceType: atomCamV2 - eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b - eventInfo: - endTime: 1662973203000 - picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... - recordingStatus: completed - startTime: 1662973200000 - type: motion - time: 1662973200000 - schema: - items: - $ref: '#/components/schemas/SoraCamEvent' - type: array + logo: "on" + motionTagging: "on" + nightVision: auto + quality: high + rotation: 0 + statusLight: "on" + timestamp: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettings' description: OK. - "400": - description: 指定された引数が不正です。 "404": - description: 指定されたソラカメ対応カメラが見つかりませんでした。 + description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラのイベント一覧を取得する + summary: ソラカメ対応カメラの各種設定を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices events list-for-device - x-soracom-cli-pagination: - request: - param: last_evaluated_key - response: - header: x-soracom-next-key - /sora_cam/devices/{device_id}/exports/usage: + - sora-cam devices atomcam get-settings + /sora_cam/devices/{device_id}/atomcam/settings/logo: get: description: | - 静止画の残りのエクスポート可能枚数や、録画映像の残りのエクスポート可能時間などを取得します。 - - **Warning**: 静止画をエクスポートしても、録画映像をエクスポートしても、動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を取得します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: getSoraCamDeviceExportUsage + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsLogo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -10971,70 +10969,102 @@ paths: content: application/json: example: - deviceId: 7CDDDEADBEEF - image: - billedFrames: 0 - limitFrames: 259200 - remainingFrames: 259131 - usedFrames: 69 - meteredYearMonth: "202209" - video: - billedSeconds: 0 - limitSeconds: 259200 - remainingSeconds: 259131 - usedSeconds: 69 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsage' + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' description: OK. "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する + summary: 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices get-export-usage - /sora_cam/devices/{device_id}/exports/usage/limit_override: - delete: + - sora-cam devices atomcam settings get-logo + post: description: | - 動画のエクスポート可能時間の上限をデフォルトの値に戻します。デフォルトは、72 時間です。 + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を変更します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: deleteSoraCamDeviceExportUsageLimitOverride + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsLogo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsLogo' responses: - "204": - description: 設定がデフォルトに戻りました。 + "200": + description: OK. + "400": + description: 不正なリクエスト。 "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: ソラカメ対応カメラの動画のエクスポート可能時間の上限をデフォルトに戻す + summary: 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定を変更する tags: - SoraCam x-soracom-cli: - - sora-cam devices delete-export-usage-limit-override - put: + - sora-cam devices atomcam settings set-logo + /sora_cam/devices/{device_id}/atomcam/settings/motion_tagging: + get: description: | - 動画のエクスポート可能時間の上限を変更します。デフォルトは、72 時間です。最大で 1,500 時間まで設定できます。 + モーションタグの表示設定を取得します。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 - **Warning**: 動画のエクスポート可能時間の消費時間が 72 時間を超えると課金が発生します。上限を変更しただけでは、課金は発生しません。動画のエクスポート可能時間の上限の設定にかかわらず、消費時間が 72 時間を超えると課金が発生します。料金について詳しくは、Soracom Cloud Camera Services ソラカメの [料金について](https://soracom.jp/sora_cam/#pricing) を参照してください。 + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - **Warning**: 上限を 72 時間未満に設定することもできます。その場合でも、料金は変わりません。 + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsMotionTagging + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: モーションタグの表示設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-motion-tagging + post: + description: | + モーションタグの表示設定を変更します。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: updateSoraCamDeviceExportUsageLimitOverride + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsMotionTagging parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11044,9 +11074,574 @@ paths: content: application/json: example: - limitHours: 144 + state: "on" schema: - $ref: '#/components/schemas/SoraCamExportUsageLimitOverrideSpecification' + $ref: '#/components/schemas/SoraCamAtomCamSettingsMotionTagging' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: モーションタグの表示設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-motion-tagging + /sora_cam/devices/{device_id}/atomcam/settings/night_vision: + get: + description: | + ナイトビジョンモードの設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ナイトビジョンモードの設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-night-vision + post: + description: | + ナイトビジョンモードの設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsNightVision + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: auto + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsNightVision' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ナイトビジョンモードの設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-night-vision + /sora_cam/devices/{device_id}/atomcam/settings/quality: + get: + description: | + クラウド録画の画質設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウド録画の画質設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-quality + post: + description: | + クラウド録画の画質設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsQuality + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: low + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsQuality' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウド録画の画質設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-quality + /sora_cam/devices/{device_id}/atomcam/settings/rotation: + get: + description: | + 画像を 180° 回転させる設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 画像を 180° 回転させる設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-rotation + post: + description: | + 画像を 180° 回転させる設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsRotation + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: 180 + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsRotation' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 画像を 180° 回転させる設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-rotation + /sora_cam/devices/{device_id}/atomcam/settings/status_light: + get: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-status-light + post: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsStatusLight + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsStatusLight' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ステータスライト (カメラ本体の状態を示すランプ) の点灯設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-status-light + /sora_cam/devices/{device_id}/atomcam/settings/timestamp: + get: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: getSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 撮影画像右下に表示されるタイムスタンプの表示設定を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings get-timestamp + post: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定を変更します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + + **Info**: この API は、[Public beta](/ja-jp/resources/glossary/#public-beta) です。 + operationId: setSoraCamDeviceAtomCamSettingsTimestamp + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + state: "on" + schema: + $ref: '#/components/schemas/SoraCamAtomCamSettingsTimestamp' + responses: + "200": + description: OK. + "400": + description: 不正なリクエスト。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: 撮影画像右下に表示されるタイムスタンプの表示設定を変更する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices atomcam settings set-timestamp + /sora_cam/devices/{device_id}/events: + get: + description: | + `device_id` で指定したソラカメ対応カメラで検出されたイベントの一覧を取得します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: listSoraCamDeviceEventsForDevice + parameters: + - description: 対象のソラカメ対応カメラの ID + in: path + name: device_id + required: true + schema: + type: string + - description: 前回の listSoraCamDeviceEventsForDevice リクエストのレスポンスに含まれていた x-soracom-next-key + ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: 1 回のリクエストで取得するデータ数の最大値。なお、レスポンスには、指定した最大値よりも少ないデータしか含まれないことがあります。 + in: query + name: limit + required: false + schema: + default: 10 + type: integer + - description: イベントを取得する期間の開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラで検出された最も古いイベントの発生時刻が設定されます。 + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: イベントを取得する期間の終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: | + イベント一覧のソート順。 + + - `desc`: 降順 (対象のソラカメ対応カメラで検出された最新のイベントが先頭) + - `asc`: 昇順 (対象のソラカメ対応カメラで検出された最も古いイベントが先頭) + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc + type: string + responses: + "200": + content: + application/json: + example: + - deviceId: 7CDDDEADBEEF + deviceType: atomCamV2 + eventId: 5ed62746-6c53-47e5-94e6-90697057cf5b + eventInfo: + endTime: 1662973203000 + picture: https://atom-device-alarm-file.s3.ap-northeast-1.amazonaws.com/7CDDDEADBEEF/2022-12-12/7CDDDEADBEEF131670825831_1670825831000_13_1_0/xxx.jpg?... + recordingStatus: completed + startTime: 1662973200000 + type: motion + time: 1662973200000 + schema: + items: + $ref: '#/components/schemas/SoraCamEvent' + type: array + description: OK. + "400": + description: 指定された引数が不正です。 + "404": + description: 指定されたソラカメ対応カメラが見つかりませんでした。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラのイベント一覧を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key + /sora_cam/devices/{device_id}/exports/usage: + get: + description: | + 静止画の残りのエクスポート可能枚数や、録画映像の残りのエクスポート可能時間などを取得します。 + + **Warning**: 静止画をエクスポートしても、録画映像をエクスポートしても、動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: getSoraCamDeviceExportUsage + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + deviceId: 7CDDDEADBEEF + image: + billedFrames: 0 + limitFrames: 259200 + remainingFrames: 259131 + usedFrames: 69 + meteredYearMonth: "202209" + video: + billedSeconds: 0 + limitSeconds: 259200 + remainingSeconds: 259131 + usedSeconds: 69 + schema: + $ref: '#/components/schemas/SoraCamExportUsage' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-export-usage + /sora_cam/devices/{device_id}/exports/usage/limit_override: + delete: + description: | + 動画のエクスポート可能時間の上限をデフォルトの値に戻します。デフォルトは、72 時間です。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: deleteSoraCamDeviceExportUsageLimitOverride + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "204": + description: 設定がデフォルトに戻りました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの動画のエクスポート可能時間の上限をデフォルトに戻す + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices delete-export-usage-limit-override + put: + description: | + 動画のエクスポート可能時間の上限を変更します。デフォルトは、72 時間です。最大で 1,500 時間まで設定できます。 + + **Warning**: 動画のエクスポート可能時間の消費時間が 72 時間を超えると課金が発生します。上限を変更しただけでは、課金は発生しません。動画のエクスポート可能時間の上限の設定にかかわらず、消費時間が 72 時間を超えると課金が発生します。料金について詳しくは、Soracom Cloud Camera Services ソラカメの [料金について](https://soracom.jp/sora_cam/#pricing) を参照してください。 + + **Warning**: 上限を 72 時間未満に設定することもできます。その場合でも、料金は変わりません。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: updateSoraCamDeviceExportUsageLimitOverride + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + limitHours: 144 + schema: + $ref: '#/components/schemas/SoraCamExportUsageLimitOverrideSpecification' required: true responses: "200": @@ -11090,7 +11685,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: listSoraCamDeviceImageExportsForDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11209,7 +11804,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: exportSoraCamDeviceRecordedImage parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11238,109 +11833,345 @@ paths: schema: $ref: '#/components/schemas/SoraCamImageExportInfo' description: OK. - "400": - description: '`time` に指定した値が不適切です。' + "400": + description: '`time` に指定した値が不適切です。' + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウドに保存された録画映像から静止画をエクスポートする処理を開始する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images export + /sora_cam/devices/{device_id}/images/exports/{export_id}: + get: + description: | + [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage) で開始した「録画映像から静止画をエクスポートする処理」の現在の状況をリストで取得します。この API では、対象を 1 つのエクスポート処理に限定します。 + + **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 + operationId: getSoraCamDeviceExportedImage + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + - description: 対象のエクスポート処理のエクスポート ID + in: path + name: export_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + examples: + (1) Initializing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: initializing + (2) Processing: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: processing + (3) Completed: + value: + - deviceId: 7CDDDEADBEEF + expiryTime: 1662973800000 + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: completed + url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... + (4) Retrying: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b + operatorId: OP0012345678 + requestedTime: 1662973200000 + status: retrying + (5) Failed: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: failed + (6) limitExceeded: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: limitExceeded + (7) Expired: + value: + - deviceId: 7CDDDEADBEEF + exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a + operatorId: OP0012345678 + requestedTime: 1663649222739 + status: expired + schema: + items: + $ref: '#/components/schemas/SoraCamImageExportInfo' + type: array + description: OK. + "404": + description: 指定したソラカメ対応カメラ、またはエクスポート処理が見つかりません。 + security: + - api_key: [] + api_token: [] + summary: クラウドに保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices images get-exported + /sora_cam/devices/{device_id}/name: + get: + description: ソラカメ対応カメラの現在の名前を取得します。 + operationId: getSoraCamDeviceName + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの現在の名前を取得します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-name + post: + description: ソラカメ対応カメラの名前を変更します。 + operationId: setSoraCamDeviceName + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + name: ATOM Cam 2 + schema: + $ref: '#/components/schemas/SoraCamDeviceName' + responses: + "200": + description: OK. + "400": + description: 不正なパラメーターが指定されました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの名前を変更します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-name + /sora_cam/devices/{device_id}/power_state: + get: + description: ソラカメ対応カメラの電源状態を取得します。 + operationId: getSoraCamDevicePowerState + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + description: OK. + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの電源状態を取得します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices get-power-state + post: + description: ソラカメ対応カメラの電源状態を変更します。 + operationId: setSoraCamDevicePowerState + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + example: + powerState: "on" + schema: + $ref: '#/components/schemas/SoraCamPowerState' + responses: + "200": + description: OK. + "400": + description: 不正なパラメーターが指定されました。 + "404": + description: 指定したソラカメ対応カメラが見つかりません。 + security: + - api_key: [] + api_token: [] + summary: ソラカメ対応カメラの電源状態を変更します + tags: + - SoraCam + x-soracom-cli: + - sora-cam devices set-power-state + /sora_cam/devices/{device_id}/reboot: + post: + description: ソラカメ対応カメラを再起動します。 + operationId: rebootSoraCamDevice + parameters: + - description: 対象のソラカメ対応カメラのデバイス ID。 + in: path + name: device_id + required: true + schema: + type: string + responses: + "200": + description: OK. "404": description: 指定したソラカメ対応カメラが見つかりません。 security: - api_key: [] api_token: [] - summary: クラウドに保存された録画映像から静止画をエクスポートする処理を開始する + summary: ソラカメ対応カメラを再起動します tags: - SoraCam x-soracom-cli: - - sora-cam devices images export - /sora_cam/devices/{device_id}/images/exports/{export_id}: + - sora-cam devices reboot + /sora_cam/devices/{device_id}/recordings_and_events: get: description: | - [`SoraCam:exportSoraCamDeviceRecordedImage API`](/ja-jp/tools/api/reference/#/SoraCam/exportSoraCamDeviceRecordedImage) で開始した「録画映像から静止画をエクスポートする処理」の現在の状況をリストで取得します。この API では、対象を 1 つのエクスポート処理に限定します。 + ソラカメ対応カメラがクラウドに映像を録画した期間の一覧、およびソラカメ対応カメラが検知したイベントの一覧を取得します。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 - operationId: getSoraCamDeviceExportedImage + operationId: listSoraCamDeviceRecordingsAndEvents parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: ソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true schema: type: string - - description: 対象のエクスポート処理のエクスポート ID - in: path - name: export_id - required: true + - description: 前回の listSoraCamDeviceRecordingsAndEvents リクエストのレスポンスに含まれていた x-soracom-next-key + ヘッダーの値。このパラメータを指定することで、前回のリクエストの続きからリストを取得できます。 + in: query + name: last_evaluated_key + required: false + schema: + type: string + - description: リストの取得開始時刻 (UNIX 時間 (ミリ秒))。省略した場合は、対象のソラカメ対応カメラに割り当てられたライセンスの保存期間のうち最も古い時刻が指定されます。 + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: リストの所得終了時刻 (UNIX 時間 (ミリ秒))。省略した場合は、現在時刻が設定されます。 + in: query + name: to + required: false schema: + format: int64 + type: integer + - description: | + 録画期間およびイベント一覧のソート順。 + + - `desc`: 降順 (最新のデータが先頭)。 + - `asc`: 昇順 (最も古いデータが先頭)。 + in: query + name: sort + required: false + schema: + default: desc + enum: + - desc + - asc type: string responses: "200": content: application/json: - examples: - (1) Initializing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: initializing - (2) Processing: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: processing - (3) Completed: - value: - - deviceId: 7CDDDEADBEEF - expiryTime: 1662973800000 - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: completed - url: https://soracom-sora-cam-devices-api-export-file-prod.s3.amazonaws.com/filename.jpg?... - (4) Retrying: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5b - operatorId: OP0012345678 - requestedTime: 1662973200000 - status: retrying - (5) Failed: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: failed - (6) limitExceeded: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: limitExceeded - (7) Expired: - value: - - deviceId: 7CDDDEADBEEF - exportId: 5ed62746-6c53-47e5-94e6-90697057cf5a - operatorId: OP0012345678 - requestedTime: 1663649222739 - status: expired + example: + events: + - endTime: 1699318810000 + startTime: 1699318800000 + type: motion + - endTime: 1699320820000 + startTime: 1699320810000 + type: sound + - endTime: 1699315210000 + startTime: 1699315200000 + type: motion + records: + - startTime: 1699318800000 + - endTime: 1699318800000 + startTime: 169931520000011 schema: - items: - $ref: '#/components/schemas/SoraCamImageExportInfo' - type: array + $ref: '#/components/schemas/SoraCamRecordingsAndEventsList' description: OK. + "400": + description: 不正なパラメーターが指定されました。 "404": - description: 指定したソラカメ対応カメラ、またはエクスポート処理が見つかりません。 + description: 指定されたソラカメ対応カメラ、または指定された期間の録画が見つかりませんでした。 security: - api_key: [] api_token: [] - summary: クラウドに保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する + summary: ソラカメ対応カメラが録画した期間の一覧およびイベントの一覧を取得する tags: - SoraCam x-soracom-cli: - - sora-cam devices images get-exported + - sora-cam devices recordings-and-events list-for-device + x-soracom-cli-pagination: + request: + param: last_evaluated_key + response: + header: x-soracom-next-key /sora_cam/devices/{device_id}/stream: get: description: | @@ -11353,14 +12184,12 @@ paths: - 最大 900 秒 (15 分) の録画映像をストリーミング再生できる URL を取得できます。 - URL を取得した時点で、視聴状況にかかわらず動画の視聴可能時間 (デフォルトでは 1 か月 72 時間) が消費されます。 - **Warning**: リアルタイム映像は、クラウドに保存された録画映像から最新の映像を取得する機能です。したがって、クラウド常時録画ライセンスもしくはクラウドモーション検知 “無制限” 録画ライセンスを割り当てていないソラカメ対応カメラのリアルタイム映像は取得できません。 - - **Warning**: ATOM アプリで再生できる「ライブ映像 (P2P)」は、リアルタイム映像とは異なる機能です。SORACOM API を利用して「ライブ映像 (P2P)」は取得できません。 + **Warning**: **リアルタイム映像**は、クラウドに保存された録画映像から最新の映像を取得する機能です。したがって、クラウド常時録画ライセンスもしくはクラウドモーション検知 “無制限” 録画ライセンスを割り当てていないソラカメ対応カメラのリアルタイム映像は取得できません。ATOM アプリで再生できる**「ライブ映像 (P2P)」**は、リアルタイム映像とは異なる機能です。SORACOM API を利用して「ライブ映像 (P2P)」は取得できません。 **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDeviceStreamingVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11421,7 +12250,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: listSoraCamDeviceVideoExportsForDevice parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11541,7 +12370,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: exportSoraCamDeviceRecordedVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -11592,7 +12421,7 @@ paths: **Warning**: この API を SAM ユーザーの API キーと API トークンで実行する場合は、SAM ユーザーに、この API を呼び出すために必要な権限 (例: `SoraCam:*`) に加えて、`OAuth2:authorize` を実行する権限を追加してください。権限設定について詳しくは、[SAM ユーザーの権限を設定する](/ja-jp/docs/sam/set-permissions/) を参照してください。 operationId: getSoraCamDeviceExportedVideo parameters: - - description: 対象のソラカメ対応カメラのデバイス ID + - description: 対象のソラカメ対応カメラのデバイス ID。 in: path name: device_id required: true @@ -12045,7 +12874,7 @@ paths: 現在、この API は日本カバレッジでのみ利用可能です。 operationId: updateSoraCamLicensePackQuantity parameters: - - description: ライセンスパックの ID + - description: ライセンスパックの ID。 in: path name: license_pack_id required: true @@ -12056,7 +12885,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SoraCamLicensePackQuantityUpdatingRequest' - description: ライセンス数の更新内容 + description: ライセンス数の更新内容。 required: true responses: "204": @@ -12076,7 +12905,7 @@ paths: description: Soralet の一覧を取得します。 operationId: listSoralets parameters: - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12086,7 +12915,7 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false @@ -12148,7 +12977,7 @@ paths: description: Soralet を削除します。 operationId: deleteSoralet parameters: - - description: 削除したい Soralet の識別子 + - description: 削除したい Soralet の識別子。 in: path name: soralet_id required: true @@ -12171,7 +13000,7 @@ paths: description: Soralet を取得します。 operationId: getSoralet parameters: - - description: 取得したい Soralet の識別子 + - description: 取得したい Soralet の識別子。 in: path name: soralet_id required: true @@ -12199,13 +13028,13 @@ paths: description: 指定された Soralet からのログメッセージの一覧を取得します。 operationId: getSoraletLogs parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12215,7 +13044,7 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false @@ -12254,7 +13083,7 @@ paths: description: 引数を指定して Soralet をテスト実行します。 operationId: testSoralet parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true @@ -12265,7 +13094,7 @@ paths: application/json: schema: $ref: '#/components/schemas/ExecuteSoraletRequest' - description: 実行リクエスト + description: 実行リクエスト。 required: true responses: "200": @@ -12288,13 +13117,13 @@ paths: description: Soralet のバージョン一覧を取得します。 operationId: listSoraletVersions parameters: - - description: バージョン一覧を取得したい Soralet の識別子 + - description: バージョン一覧を取得したい Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: Sort order + - description: データエントリのソート順。下降順 (最新のデータが先頭) もしくは上昇順 (最も古いデータが先頭)。 in: query name: sort required: false @@ -12304,13 +13133,13 @@ paths: - asc - desc type: string - - description: 一度のレスポンスに含まれる項目数の最大値 + - description: 一度のレスポンスに含まれる項目数の最大値。 in: query name: limit required: false schema: type: integer - - description: 現在のページで最後に取得された Soralet の識別子を指定します。このパラメータを指定することで、Soralet のリストの続きを取得できます。 + - description: 現在のページで最後に取得されたバージョンの識別子を指定します。このパラメータを指定することで、バージョンのリストの続きを取得できます。 in: query name: last_evaluated_key required: false @@ -12342,7 +13171,7 @@ paths: description: コードをアップロードし、新しいバージョンを作成します。 operationId: uploadSoraletCode parameters: - - description: コードのアップロード先の Soralet の識別子 + - description: コードのアップロード先の Soralet の識別子。 in: path name: soralet_id required: true @@ -12360,7 +13189,7 @@ paths: schema: format: binary type: string - description: アップロードしたいファイルの内容 + description: アップロードしたいファイルの内容。 required: true responses: "201": @@ -12382,13 +13211,13 @@ paths: description: Soralet のバージョンを削除します。 operationId: deleteSoraletVersion parameters: - - description: Soralet の識別子 + - description: Soralet の識別子。 in: path name: soralet_id required: true schema: type: string - - description: 削除したい Soralet のバージョン + - description: 削除したい Soralet のバージョン。 in: path name: version required: true @@ -12418,29 +13247,13 @@ paths: required: true schema: type: string - - description: | - 集計対象期間の開始月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 + - description: 対象期間の開始月/日を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: | - 集計対象期間の終了月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 + - description: 対象期間の終了月/日を UNIX 時間 (秒) で指定します。 in: query name: to required: true @@ -12449,8 +13262,22 @@ paths: - description: | 集計単位。 - - month: 月ごとに集計します。 - - day: 日ごとに集計します。 + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 7 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | in: query name: period required: true @@ -12489,29 +13316,13 @@ paths: required: true schema: type: string - - description: | - 集計対象期間の開始月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の開始時刻は、指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 + - description: 対象期間の開始月/日を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: | - 集計対象期間の終了月/日を UNIX 時間 (秒) で指定します。なお、`period` の値によって指定できる値および動作が異なります。 - - - `period` が `month` の場合: - - 現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 - - `period` が `day` の場合: - - 現在時刻の 6 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。 - - 実際の集計対象期間の終了時刻は、指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 + - description: 対象期間の終了月/日を UNIX 時間 (秒) で指定します。 in: query name: to required: true @@ -12520,8 +13331,22 @@ paths: - description: | 集計単位。 - - month: 月ごとに集計します。 - - day: 日ごとに集計します。 + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 3 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 7 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | in: query name: period required: true @@ -12620,20 +13445,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で通信量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で通信量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12674,20 +13524,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で通信量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で通信量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12768,20 +13643,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12862,20 +13762,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -12956,20 +13881,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -13007,7 +13957,7 @@ paths: required: true schema: type: string - - description: 年月を YYYYMM 形式で指定します。 + - description: 現在時刻の 18 か月前 〜 現在時刻の年月を YYYYMM 形式で指定します。 in: query name: year_month required: false @@ -13028,6 +13978,55 @@ paths: - Stats x-soracom-cli: - stats harvest operators get + /stats/harvest/operators/{operator_id}/export: + post: + description: | + オペレーターが所有していたすべての IoT SIM の SORACOM Harvest Data への書き込み回数を、[Harvest Data 書き込み回数実績データ CSV](/ja-jp/docs/harvest/stats-csv/) でダウンロードします。 + + **Info**: 解約した IoT SIM の SORACOM Harvest Data への書き込み回数も確認できます。 + operationId: exportHarvestStats + parameters: + - description: オペレーター ID。 + in: path + name: operator_id + required: true + schema: + type: string + - description: | + Harvest Data 書き込み回数実績データ CSV をダウンロードするための URL を取得する方法を指定します。 + + - `async`: SORACOM プラットフォームで URL が発行されるのを待たずに、`exportedFieldId` を取得します。この `exportedFieldId` を [`Files:getExportedFile API`](#/Files/getExportedFile) で指定すると、URL を取得できます。Harvest Data 書き込み回数実績データ CSV のファイルサイズが大きい場合は、`async` を利用してください。 + - `sync` (デフォルト): SORACOM プラットフォームで URL が発行されるのを待ちます。ただし、Harvest Data 書き込み回数実績データ CSV のファイルサイズが大きい場合など、タイムアウトして URL を取得できないことがあります。タイムアウトする場合は、`async` を指定してください。 + in: query + name: export_mode + required: false + schema: + enum: + - async + - sync + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportRequest' + description: 出力するデータの期間。 + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FileExportResponse' + description: OK. + security: + - api_key: [] + api_token: [] + summary: すべての IoT SIM の Harvest Data 書き込み回数をエクスポートする + tags: + - Stats + x-soracom-cli: + - stats harvest export /stats/harvest/subscribers/{imsi}: get: description: IMSI で指定した Subscriber の SORACOM Harvest Data 利用量履歴を取得する。 @@ -13039,20 +14038,45 @@ paths: required: true schema: type: string - - description: 集計対象時刻の始まりを UNIX 時間 (秒) で与える + - description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 in: query name: from required: true schema: type: integer - - description: 集計対象時刻の終わりを UNIX 時間 (秒) で与える + - description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 in: query name: to required: true schema: type: integer - - description: 集計単位。minutes は最も細かい粒度で利用量履歴を出力します。ただし、デバイスが SORACOM プラットフォームに接続している間は、約 - 5 分間隔で利用量が記録されます。 + - description: | + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | in: query name: period required: true @@ -13084,7 +14108,7 @@ paths: description: 指定された年月における Napter 監査ログの読み込みデータ通信量を byte 単位で取得する。 operationId: getNapterAuditLogsExportedDataStats parameters: - - description: 年月を YYYYMM 形式で指定します。 + - description: 現在時刻の 18 か月前 〜 現在時刻の年月を YYYYMM 形式で指定します。 in: query name: year_month required: false @@ -13140,8 +14164,19 @@ paths: required: false schema: type: string - - description: '検索対象にする速度クラス。`|`で区切って複数指定することができる。指定可能な値の一覧は以下のとおり: `s1.minimum`, - `s1.slow`, `s1.standard`, `s1.fast`' + - description: | + 検索対象にする速度クラス。`|`で区切って複数指定することができる。指定可能な値の一覧は以下のとおり: + + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - `u1.standard` + - `u1.slow` + - `t1.standard` + - `arc.standard` in: query name: speed_class_filter required: false @@ -13327,11 +14362,13 @@ paths: - desc - asc type: string - - description: 取得するデータエントリ数の上限。デフォルトは、`10` です。 + - description: 取得するデータエントリ数の上限 (1 〜 1000)。デフォルトは、`10` です。 in: query name: limit required: false schema: + maximum: 1000 + minimum: 1 type: integer - description: | 前のページで取得した最後のデータエントリのキー。この API でのデータエントリーのキーは、`${UNIX 時間 (ミリ秒)}_${IMSI}` です。このパラメータを指定することで次のデータエントリを取得できます。 @@ -13759,7 +14796,7 @@ paths: application/json: schema: $ref: '#/components/schemas/SetImeiLockRequest' - description: Subscriber に指定する IMEI lock の設定 （オンラインの Subscriber の現在の IMEI にロックするには + description: Subscriber に指定する IMEI ロックの設定 （オンラインの Subscriber の現在の IMEI にロックするには IMEI は指定しなくてもよい） responses: "200": @@ -14530,7 +15567,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable: post: description: SIM ベースルーティングを無効化します。 - operationId: disableSimBasedRouging + operationId: disableSimBasedRouting parameters: - description: 対象の VPG の ID in: path @@ -14554,7 +15591,7 @@ paths: /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable: post: description: SIM ベースルーティングを有効化します。 - operationId: enableSimBasedRouging + operationId: enableSimBasedRouting parameters: - description: 対象の VPG の ID in: path @@ -14924,7 +15961,7 @@ paths: - vpg unset-redirection /virtual_private_gateways/{vpg_id}/packet_capture_sessions: get: - description: 指定された VPG のパケットキャプチャセッションのリストを取得する。 + description: VPG に対するパケットキャプチャセッションのリストを取得する。 operationId: listPacketCaptureSessions parameters: - description: 対象の VPG ID @@ -14956,7 +15993,7 @@ paths: items: $ref: '#/components/schemas/PacketCaptureSession' type: array - description: 指定された VPG のパケットキャプチャセッションのリスト + description: VPG に対するパケットキャプチャセッションのリスト "400": description: Failed to list packet capture sessions associated with the VPG @@ -14965,7 +16002,7 @@ paths: security: - api_key: [] api_token: [] - summary: List Packet Capture Sessions + summary: VPG に対するパケットキャプチャセッションのリストを取得する tags: - VirtualPrivateGateway x-soracom-cli: @@ -14976,7 +16013,7 @@ paths: response: header: x-soracom-next-key post: - description: 指定された VPG に対するパケットキャプチャセッションを作成する。 + description: VPG に対するパケットキャプチャセッションを作成する。 operationId: createPacketCaptureSession parameters: - description: 対象の VPG ID @@ -14998,22 +16035,22 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定された VPG に対するパケットキャプチャセッションの作成が成功した + description: VPG に対するパケットキャプチャセッション "400": - description: 指定された VPG に対するパケットキャプチャセッションの作成が失敗した + description: VPG に対するパケットキャプチャセッションの作成が失敗した "404": description: 指定された VPG が存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを作成する + summary: VPG に対するパケットキャプチャセッションを作成する tags: - VirtualPrivateGateway x-soracom-cli: - vpg create-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}: delete: - description: 指定した VPG 対するパケットキャプチャを削除する。 + description: VPG に対するパケットキャプチャセッションを削除する。 operationId: deletePacketCaptureSession parameters: - description: 対象の VPG ID @@ -15036,19 +16073,19 @@ paths: $ref: '#/components/schemas/PacketCaptureSession' description: 削除されたパケットキャプチャセッションの情報 "400": - description: 指定されたパケットキャプチャセッションの削除に失敗 + description: VPG に対するパケットキャプチャセッションの削除に失敗 "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションを削除する + summary: VPG に対するパケットキャプチャセッションを削除する tags: - VirtualPrivateGateway x-soracom-cli: - vpg delete-packet-capture-session get: - description: 指定した VPG に対するパケットキャプチャを取得する。 + description: VPG に対するパケットキャプチャセッションを取得する。 operationId: getPacketCaptureSession parameters: - description: 対象の VPG ID @@ -15057,7 +16094,7 @@ paths: required: true schema: type: string - - description: パケットキャプチャセッション ID + - description: 対象のパケットキャプチャセッション ID in: path name: session_id required: true @@ -15069,20 +16106,20 @@ paths: application/json: schema: $ref: '#/components/schemas/PacketCaptureSession' - description: 指定されたパケットキャプチャセッション + description: VPG に対するパケットキャプチャセッション "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない security: - api_key: [] api_token: [] - summary: パケットキャプチャセッションの情報を取得する + summary: VPG に対するパケットキャプチャセッションを取得する tags: - VirtualPrivateGateway x-soracom-cli: - vpg get-packet-capture-session /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop: post: - description: 指定した SIM に対するパケットキャプチャを停止する。 + description: VPG に対するパケットキャプチャセッションを停止する。 operationId: stopPacketCaptureSession parameters: - description: 対象の VPG ID @@ -15108,13 +16145,13 @@ paths: description: The packet capture session can be stopped only when its status is CAPTURING "404": - description: 指定されたパケットキャプチャセッションが存在しない + description: VPG に対するパケットキャプチャセッションが存在しない "500": - description: 指定されたパケットキャプチャセッションが停止できなかった + description: VPG に対するパケットキャプチャセッションが停止できなかった security: - api_key: [] api_token: [] - summary: Stop Packet Capture Session + summary: VPG に対するパケットキャプチャセッションを停止する tags: - VirtualPrivateGateway x-soracom-cli: @@ -15247,7 +16284,10 @@ paths: - vpg delete-vpc-peering-connection /volume_discounts: get: - description: 契約済みの長期利用割引リストを返します。 + description: | + 契約済みの長期利用割引リストを返します。 + + **Warning**: 取得できる情報は、過去 18 か月、または契約が終了してから 6 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: listVolumeDiscounts responses: "200": @@ -15265,8 +16305,8 @@ paths: x-soracom-cli: - volume-discounts list post: - description: 新規で長期利用割引の見積もりの作成を行います。orderId を/confirm に PUT すると発注が完了します。(現時点では、長期利用割引は - plan-D バンドルなし、plan-K でのみ利用できます。) + description: 新規で長期利用割引の見積もりの作成を行います。orderId を /volume_discounts/{order_id}/confirm + に PUT すると発注が完了します (現時点では、長期利用割引は plan-D バンドルなし、plan-K でのみ利用できます)。 operationId: createVolumeDiscountQuotation requestBody: content: @@ -15292,10 +16332,13 @@ paths: - volume-discounts create /volume_discounts/{contract_id}: get: - description: 契約済みの長期利用割引を返します。 + description: | + 契約済みの長期利用割引を取得します。 + + **Warning**: 取得できる情報は、過去 18 か月、または契約が終了してから 6 か月までです。それ以前の情報が必要な場合は、[SORACOM サポート](/ja-jp/guides/support/) に問い合わせてください。 operationId: getVolumeDiscount parameters: - - description: contract_id + - description: 契約 ID。 in: path name: contract_id required: true @@ -15504,7 +16547,7 @@ components: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateCredentialsModel' - description: credentials + description: 認証情報。 required: true DeviceObjectModel: content: @@ -15535,7 +16578,7 @@ components: application/json: schema: $ref: '#/components/schemas/LagoonPlanChangingRequest' - description: req + description: リクエスト。 required: true MFAAuthenticationRequest: content: @@ -15610,19 +16653,19 @@ components: ActionConfigProperty: properties: accessKey: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string body: - description: ExecuteWebRequestAction の時のみ有効(任意) + description: ExecuteWebRequestAction のときのみ有効(任意)。 type: string contentType: - description: ExecuteWebRequestAction の時のみ有効 + description: ExecuteWebRequestAction のときのみ有効。 type: string endpoint: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string executionDateTimeConst: - description: executionDateTimeConst で指定したタイミングから指定分後に実行 + description: アクションを実行するタイミング。 enum: - IMMEDIATELY - BEGINNING_OF_NEXT_MONTH @@ -15631,16 +16674,16 @@ components: - NEVER type: string executionOffsetMinutes: - description: Run in the minutes after the timing of executionDateTimeConst + description: executionDateTimeConst で指定したタイミングから指定分後に実行。 type: string functionName: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string headers: - description: ExecuteWebRequestAction の時のみ有効(任意) + description: ExecuteWebRequestAction のときのみ有効(任意)。 type: object httpMethod: - description: ExecuteWebRequestAction の時のみ有効 + description: ExecuteWebRequestAction のときのみ有効。 enum: - GET - POST @@ -15648,43 +16691,46 @@ components: - DELETE type: string message: - description: SendMailAction, SendMailToOperatorAction の時のみ有効 + description: SendMailAction、SendMailToOperatorAction のときのみ有効。 type: string parameter1: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter2: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter3: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter4: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string parameter5: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string secretAccessKey: - description: InvokeAWSLambdaAction の時のみ有効 + description: InvokeAWSLambdaAction のときのみ有効。 type: string speedClass: - description: ChangeSpeedClassAction の時のみ有効 + description: ChangeSpeedClassAction のときのみ有効。 enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string title: - description: SendMailAction, SendMailToOperatorAction の時のみ有効 + description: SendMailAction、SendMailToOperatorAction のときのみ有効。 type: string to: - description: SendMailAction の時のみ有効 + description: SendMailAction のときのみ有効。 type: string url: - description: 接続先 URL とパラメータ ExecuteWebRequestAction の時のみ有効 + description: 接続先 URL とパラメータ。ExecuteWebRequestAction のときのみ有効。 type: string required: - executionDateTimeConst @@ -16057,15 +17103,15 @@ components: description: リクエストとそれに対する結果を結びつけるための識別子。 type: string lat: - description: 推定座標の緯度 + description: 推定座標の緯度。 format: double type: number lon: - description: 推定座標の経度 + description: 推定座標の経度。 format: double type: number range: - description: 基地局のエリアの範囲（推定座標からの半径。メートル単位）。測定値から推定された値の場合と、信頼できる情報源から得た値の場合がある。 + description: 基地局のエリアの範囲 (推定座標からの半径。メートル単位)。測定値から推定された値の場合と、信頼できる情報源から得た値の場合がある。 format: int32 type: integer samples: @@ -16272,6 +17318,8 @@ components: type: object CreateGroupRequest: properties: + configuration: + $ref: '#/components/schemas/GroupConfiguration' tags: $ref: '#/components/schemas/TagSet' type: object @@ -16280,7 +17328,7 @@ components: description: type: string permission: - description: Permission の JSON + description: パーミッションの JSON。 type: string required: - permission @@ -16290,12 +17338,12 @@ components: destination: $ref: '#/components/schemas/PortMappingDestination' duration: - description: リモートアクセスを有効にする時間 (秒単位) + description: リモートアクセスを有効にする時間 (秒単位)。 type: number source: $ref: '#/components/schemas/PortMappingSource' tlsRequired: - description: リモートアクセスに TLS を使用するかどうか + description: リモートアクセスに TLS を使用するかどうか。 type: boolean required: - destination @@ -16388,14 +17436,39 @@ components: type: integer type: enum: + - api-token-credentials - aws-credentials + - aws-iam-role-credentials - azure-credentials + - azureIoT-credentials + - esrij-credentials + - google-service-account-json + - googleIoT-credentials + - infoteria-platio-credentials + - kii-thingif-credentials + - landlog-credentials + - mmcloud-credentials + - mockmock-datarecorder-credentials + - motionboard-credentials + - optim-cloud-IoT-OS-credentials + - private-key-pem - psk + - pubnub-credentials + - sensorcorpus-credentials + - username-password-credentials + - watsonIoT-credentials - x509 type: string updateDateTime: format: int64 type: integer + required: + - createDateTime + - credentials + - credentialsId + - lastUsedDateTime + - type + - updateDateTime type: object CreditCard: properties: @@ -16543,12 +17616,12 @@ components: DiagnosticRequest: properties: from: - description: 診断対象期間の始まり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の始まり (UNIX 時間 (ミリ秒))。 format: int64 type: integer resourceId: description: | - resourceType に応じた識別子 + resourceType に応じた識別子。 - resourceType が `sim` の場合は、SIM ID を指定します。 type: string @@ -16561,7 +17634,7 @@ components: - Air type: string to: - description: 診断対象期間の終わり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の終わり (UNIX 時間 (ミリ秒))。 format: int64 type: integer required: @@ -16574,7 +17647,7 @@ components: diagnosticId: type: string from: - description: 診断対象期間の始まり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の始まり (UNIX 時間 (ミリ秒))。 format: int64 type: integer insights: @@ -16584,7 +17657,7 @@ components: type: object type: array resourceId: - description: resourceType に応じた識別子 + description: resourceType に応じた識別子。 type: string resourceType: enum: @@ -16601,7 +17674,7 @@ components: - failed type: string to: - description: 診断対象期間の終わり (UNIX 時間 (ミリ秒)) + description: 診断対象期間の終わり (UNIX 時間 (ミリ秒))。 format: int64 type: integer type: object @@ -16633,13 +17706,21 @@ components: EmailConfigurationOfBilling: properties: attachInvoicePdfEnabled: - description: true の場合、毎月の請求メールに請求書 PDF を添付します（グローバルカバレッジのみ）。 + description: | + 毎月の請求に関するお知らせメールにソラコム発行の請求書 (PDF) を添付するかどうかの設定 (グローバルカバレッジのみ)。 + + - `true`: 添付します。 + - `false`: 添付しません。 type: boolean type: object EmailConfigurationOfNotification: properties: exceedBundleDisabled: - description: true の場合、通信量がバンドルの容量に近づいた時に送付する通知メールを全て無効にします。 + description: | + データ通信量に関するプライマリメールアドレスへの通知設定。詳しくは、[データ通信量に関する通知を停止する](/ja-jp/docs/air/set-bundle/#データ通信量に関する通知を停止する) を参照してください。 + + - `true`: データ通信量に関するプライマリメールアドレスへの通知をすべて停止します。 + - `false`: データ通信量に関するプライマリメールアドレスへの通知をすべて有効化します。 type: boolean type: object EmailsModel: @@ -16655,13 +17736,15 @@ components: format: int64 type: integer verified: - description: メールアドレス宛てに送信されたトークンを用いて認証済みかどうか + description: メールアドレス宛てに送信されたトークンを用いて認証済みかどうか。 type: boolean type: object EnableMFAOTPResponse: properties: totpUri: type: string + required: + - totpUri type: object Error: properties: @@ -16706,7 +17789,6 @@ components: properties: product: $ref: '#/components/schemas/ProductModel' - description: 商品 productAmount: description: 商品金額 format: double @@ -16764,7 +17846,6 @@ components: type: string shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' - description: 発送先 shippingAddressId: description: 商品発送先 ID type: string @@ -16814,7 +17895,6 @@ components: type: number volumeDiscount: $ref: '#/components/schemas/VolumeDiscountModel' - description: 長期利用割引 type: object EventHandlerModel: properties: @@ -16925,24 +18005,45 @@ components: ExportRequest: properties: from: - description: 対象期間の開始日時 (UNIX 時間 (秒)) + description: 対象期間の開始月/日/分を UNIX 時間 (秒) で指定します。 example: 1654009200 format: int64 type: integer period: description: | - 履歴の詳細度。 + 集計単位。 + + - `month`: 月ごと。 + + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む月の 1 日 00:00:00 です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む月の月末の 24:00:00 です。 | + - `day`: 日ごと。 - - `month`: 月ごと - - `day`: 日ごと - - `minutes`: 分ごと + `from` と `to` には、現在時刻の 18 か月前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む日の 00:00:00 です 。| + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む日の 24:00:00 です。 | + - `minutes`: 約 5 分ごと。 + + `from` と `to` には、現在時刻の 32 日前 〜 現在時刻の UNIX 時間 (秒) を指定してください。実際の集計対象期間は、`from` と `to` で指定した時刻ではありません。 + + | 項目 | 説明 | + |-|-| + | 実際の開始時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の開始時刻です。 | + | 実際の終了時刻 | 指定した UNIX 時間 (秒) を含む約 5 分間の終了時刻です。 | enum: - month - day - minutes type: string to: - description: 対象期間の終了日時 (UNIX 時間 (秒)) + description: 対象期間の終了月/日/分を UNIX 時間 (秒) で指定します。 example: 1656601200 format: int64 type: integer @@ -17349,15 +18450,15 @@ components: attributes: properties: contractEndingTime: - description: SORACOM LTE-M Button powered by AWS の有効期限 + description: SORACOM LTE-M Button powered by AWS の有効期限。 format: date-time type: string firstClickTimestamp: - description: SORACOM LTE-M Button powered by AWS を初めてクリックした日時 + description: SORACOM LTE-M Button powered by AWS を初めてクリックした日時。 format: date-time type: string remainingCount: - description: SORACOM LTE-M Button powered by AWS の残りクリック回数 + description: SORACOM LTE-M Button powered by AWS の残りクリック回数。 type: integer wimaxBillingStartDate: description: ソラカメ専用セルラーパックの課金開始日。 @@ -17372,25 +18473,25 @@ components: type: string type: object createdTime: - description: Gadget API 対応デバイスを登録した UNIX 時間 (ミリ秒) + description: Gadget API 対応デバイスを登録した UNIX 時間 (ミリ秒)。 format: int64 type: integer id: - description: Gadget API 対応デバイスの ID + description: Gadget API 対応デバイスの ID。 type: string lastModifiedTime: - description: Gadget API 対応デバイスの情報が変更された UNIX 時間 (ミリ秒) + description: Gadget API 対応デバイスの情報が変更された UNIX 時間 (ミリ秒)。 format: int64 type: integer lastSeen: properties: batteryLevel: - description: SORACOM LTE-M Button powered by AWS のバッテリーレベル + description: SORACOM LTE-M Button powered by AWS のバッテリーレベル。 type: integer clickEventPropagated: type: boolean clickTime: - description: SORACOM LTE-M Button powered by AWS をクリックした日時 + description: SORACOM LTE-M Button powered by AWS をクリックした日時。 format: date-time type: string clickType: @@ -17400,27 +18501,27 @@ components: type: string type: object operatorId: - description: Gadget API 対応デバイスを登録したオペレーター ID + description: Gadget API 対応デバイスを登録したオペレーター ID。 type: string productId: description: | - Gadget API 対応デバイスのタイプ + Gadget API 対応デバイスのタイプ。 - - `button`: SORACOM LTE-M Button powered by AWS - - `wimax`: ソラカメ専用セルラーパック + - `button`: SORACOM LTE-M Button powered by AWS。 + - `wimax`: ソラカメ専用セルラーパック。 enum: - button - wimax type: string serialNumber: - description: Gadget API 対応デバイスのシリアル番号 + description: Gadget API 対応デバイスのシリアル番号。 type: string status: description: | - Gadget API 対応デバイスの契約状態 + Gadget API 対応デバイスの契約状態。 - - `active`: 契約中 - - `terminated`: 解約済み + - `active`: 契約中。 + - `terminated`: 解約済み。 enum: - active - terminated @@ -17437,10 +18538,10 @@ components: terminationEnabled: default: false description: | - Gadget API 対応デバイスの解約プロテクション + Gadget API 対応デバイスの解約プロテクション。 - - `true`: OFF (解約できる) - - `false`: ON (解約できない) + - `true`: OFF (解約できる)。 + - `false`: ON (解約できない)。 type: boolean type: object GadgetRegistrationRequest: @@ -17448,7 +18549,7 @@ components: tags: additionalProperties: type: string - description: タグ + description: タグ。 type: object type: object GatePeer: @@ -17474,9 +18575,9 @@ components: tokenTimeoutSeconds: default: 86400 description: | - 新しい API トークンの有効期限の長さ（秒単位）。 - 指定しなければデフォルトは 86400 [秒]（24 時間）。 - 最大値は 172800 [秒]（48 時間）。 + 新しい API トークンの有効期限の長さ (秒単位)。 + 指定しなければデフォルトは 86400 [秒] (24 時間)。 + 最大値は 172800 [秒] (48 時間)。 maximum: 172800 type: integer type: object @@ -17563,43 +18664,43 @@ components: GetOrderResponse: properties: appliedShippingOptions: - description: 適用済み配送オプション + description: 適用済み配送オプション。 items: type: object type: array balanceDue: - description: 差引請求額 + description: 差引請求額。 format: double type: number containsTaxIncludedAmounts: type: boolean currency: - description: 通貨 + description: 通貨。 enum: - JPY - USD - EUR type: string email: - description: メールアドレス + description: メールアドレス。 type: string orderChannel: - description: 発注チャンネル + description: 発注チャンネル。 type: string orderDateTime: - description: 発注日時 (yyyyMMddHHmmss) + description: 発注日時 (yyyyMMddHHmmss)。 format: yyyyMMddHHmmss type: string orderId: - description: 発注 ID + description: 発注 ID。 type: string orderItemList: - description: 発注商品リスト + description: 発注商品リスト。 items: $ref: '#/components/schemas/EstimatedOrderItemModel' type: array orderStatus: - description: 発注ステータス + description: 発注ステータス。 enum: - ordering - ordered @@ -17610,49 +18711,93 @@ components: - cancelled - failed type: string + paymentStatus: + description: | + お支払い状況。詳しくは、FAQ: [ご利用料金のお支払状況について](https://support.soracom.io/hc/ja/articles/360029337031) を参照してください。 + + - `lessThanMinimumCharge`: 翌月以降請求 (最低課金額に満たないため)。 + - `paying`: 支払い処理中。 + - `paid`: 支払い済み。 + - `fail`: 処理失敗。 + - `refunding`: リファンド処理中。 + - `refunded`: リファンド済み。 + - `refund_fail`: リファンド処理失敗。 + - `delegating_to_third_party`: 債権譲渡中。 + - `delegated_to_third_party`: 債権譲渡済み。 + - `charging`: 請求実施中。 + - `canceling`: キャンセル中。 + - `cancelled`: キャンセル済み。 + - `cancel_failed`: キャンセル処理失敗。 + enum: + - lessThanMinimumCharge + - paying + - paid + - fail + - refunding + - refunded + - refund_fail + - delegating_to_third_party + - delegated_to_third_party + - charging + - canceling + - cancelled + - cancel_failed + type: string preferredDeliveryDate: - description: 希望納品日 + description: 希望納品日。 type: string purchaseOrderNumber: - description: 注文番号 + description: 注文番号。 type: string resourceInitialSetting: $ref: '#/components/schemas/ResourceInitialSetting' shippingAddress: $ref: '#/components/schemas/ShippingAddressModel' - description: 発送先 shippingAddressId: - description: 商品発送先 ID + description: 商品発送先 ID。 type: string shippingCost: - description: 配送料 + description: 配送料。 format: double type: number + shippingDateTime: + description: 発送日時 (yyyyMMddHHmmss)。 + example: 20231004123456 + format: yyyyMMddHHmmss + type: string + shippingLabelDetails: + description: 配送業者の追跡情報。 + items: + $ref: '#/components/schemas/ShippingLabelDetail' + type: array shippingLabelNumber: - description: 宅配便送り状番号 (代表) + description: 配送業者の伝票番号 (代表)。 + example: 0000-1111-2222 type: string shippingLabelNumbers: - description: 宅配便送り状番号 + description: 配送業者の伝票番号。 + example: + - 0000-1111-2222 items: type: string type: array taxAmount: - description: 税額 + description: 税額。 format: double type: number taxIncludedInShippingCost: - description: 送料に含まれる税額 + description: 送料に含まれる税額。 format: double type: number taxOnShippingCost: - description: 配送料の課税有無 + description: 配送料の課税有無。 type: boolean totalAmount: - description: 合計額 (税込) + description: 合計額 (税込)。 format: double type: number withholdingTaxAmount: - description: 源泉徴収税額 + description: 源泉徴収税額。 format: double type: number type: object @@ -17749,10 +18894,10 @@ components: phoneNumber: type: string shippingAddressId: - description: 配送先 ID + description: 配送先 ID。 type: string shippingArea: - description: 配送先エリア + description: 配送先エリア。 type: string state: type: string @@ -17784,10 +18929,12 @@ components: properties: trustPolicy: description: | - 信頼ポリシー (JSON)。以下の情報が含まれます。詳しくは、[信頼ポリシー構文](/ja-jp/docs/switch-user/trust-policy/) を参照してください。 + この SAM ユーザーにスイッチできるルートユーザーまたは SAM ユーザーを指定する信頼ポリシー。以下の情報が含まれます。 - - `operator_id` と `user_name` で指定した SAM ユーザーにスイッチできるユーザーを表す SRN (Soracom Resource Name)。 + - この SAM ユーザーにスイッチできる別のアカウントのユーザーを表す SRN (Soracom Resource Name)。 - スイッチできる条件。 + + 詳しくは、[信頼ポリシー構文](/ja-jp/docs/switch-user/trust-policy/) を参照してください。 type: string type: object GetVolumeDiscountResponse: @@ -17805,7 +18952,7 @@ components: format: int32 type: integer currency: - description: Currency + description: 通貨 enum: - JPY - USD @@ -17854,7 +19001,7 @@ components: Group: properties: configuration: - $ref: '#/components/schemas/Map' + $ref: '#/components/schemas/GroupConfiguration' createdTime: format: int64 type: integer @@ -17868,6 +19015,27 @@ components: tags: $ref: '#/components/schemas/TagSet' type: object + GroupConfiguration: + additionalProperties: + description: | + キーは、以下のいずれかのネームスペースです。 + + - SoracomAir + - SoracomBeam + - SoracomEndorse + - SoracomOrbit + - SoracomFunk + - SoracomFunnel + - SoracomHarvest + - SoracomHarvestFiles + - SoracomKrypton + - UnifiedEndpoint + + 値は、ネームスペースごとに異なるオブジェクトです。 + type: object + description: | + グループの設定。 + type: object GroupConfigurationUpdateRequest: properties: key: @@ -17933,8 +19101,8 @@ components: Insight: properties: anomalyDetectedTimes: - description: 異常と思われる状況を検出した時間。フォーマットは category に関するイベントのタイムスタンプに依存します。（例：session - の場合は UNIX 時間 (ミリ秒)） + description: 異常と思われる状況を検出した時間。フォーマットは category に関するイベントのタイムスタンプに依存します。(例：session + の場合は UNIX 時間 (ミリ秒)) items: type: string type: array @@ -17951,7 +19119,7 @@ components: message: type: string referenceUrls: - description: インサイトに関連のある参考情報の URL + description: インサイトに関連のある参考情報の URL。 items: additionalProperties: $ref: '#/components/schemas/ReferenceUrl' @@ -17983,10 +19151,10 @@ components: IssueAddEmailTokenRequest: properties: email: - description: 追加するメールアドレス + description: 追加するメールアドレス。 type: string password: - description: ルートユーザーのパスワード + description: ルートユーザーのパスワード。 type: string required: - email @@ -18125,8 +19293,8 @@ components: licensePackName: description: | 個数を変更するライセンスパックを指定します。 - - `basicUser`: ユーザー追加パック - - `basicDashboard`: ダッシュボード追加パック + - `basicUser`: ユーザー追加パック。 + - `basicDashboard`: ダッシュボード追加パック。 enum: - basicUser - basicDashboard @@ -18137,7 +19305,7 @@ components: LagoonMigrationRequest: properties: dashboardIds: - description: A list of dashboard IDs to migrate + description: バージョン移行する Dashboard の ID のリスト。 items: type: string type: array @@ -18160,30 +19328,30 @@ components: - pro type: string userPassword: - description: This password is used by the initial user's login. + description: はじめに作成される Lagoon ユーザーのパスワード。 type: string type: object LagoonRegistrationResponse: properties: lagoonUserEmail: - description: This email address is used on login with the initial user. + description: はじめに作成される Lagoon ユーザーのメールアドレス。 type: string type: object LagoonUser: properties: email: - description: This value used on login. + description: Lagoon ユーザーのメールアドレス。 type: string id: type: number lastSeenAt: - description: The last login datetime. + description: 最終ログイン日時。 type: string lastSeenAtAge: - description: The last login datetime as age. + description: 最終ログインからの経過日数。 type: string role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18192,7 +19360,7 @@ components: LagoonUserCreationRequest: properties: role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18205,7 +19373,7 @@ components: LagoonUserCreationResponse: properties: id: - description: Lagoon user ID assigned to the created user. + description: Lagoon ユーザーの ID。 type: integer type: object LagoonUserEmailUpdatingRequest: @@ -18223,7 +19391,7 @@ components: LagoonUserPermissionUpdatingRequest: properties: role: - description: A role that represents the permission. + description: 権限を表すロール。 enum: - Viewer - Editor @@ -18471,7 +19639,7 @@ components: MFARevokeRequest: properties: password: - description: ルートユーザーのパスワード + description: ルートユーザーのパスワード。 type: string required: - password @@ -18642,6 +19810,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfEmail' - $ref: '#/components/schemas/OperatorConfigurationOfSupport' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' isModifiable: description: false の場合、コンフィグレーションを setOperatorConfigurationNamespace API で更新できません。 @@ -18653,7 +19822,7 @@ components: - Email type: string version: - description: コンフィグレーションのバージョン + description: コンフィグレーションのバージョン。 type: number type: object OperatorConfigurationOfEmail: @@ -18678,6 +19847,15 @@ components: - $ref: '#/components/schemas/SupportTier' description: 来月に適用される予定のサポートプランです。この値が無い場合は、翌月も現在のサポートプランが継続されます。 type: object + OperatorConfigurationOfUserConsole: + properties: + usageMetricsAcknowledged: + description: オペレーターが使用状況メトリクスを収集することを認識し、オプトアウトする機会が与えられたことを示します。使用状況メトリクスには、ページビューやパフォーマンス統計などの情報が含まれます。 + type: boolean + usageMetricsDisabled: + description: ユーザーコンソールの使用状況メトリクスの収集を無効にするかどうかの設定です。使用状況メトリクスには、ページビューやパフォーマンス統計などの情報が含まれます。 + type: boolean + type: object OperatorMFAVerifyingResponse: properties: backupCodes: @@ -18825,7 +20003,7 @@ components: format: double type: number chargedYearMonths: - description: この請求に含まれる利用年月のリスト。請求内容が月額費用でない場合は、このフィールドは省略されます。 月額利用料金が一定金額未満の場合は翌月に繰り越されることがあり、そのようなケースでは複数月含まれることがあります。 + description: この請求に含まれる利用年月のリスト。請求内容が月額費用でない場合は、このフィールドは省略されます。月額利用料金が一定金額未満の場合は翌月に繰り越されることがあり、そのようなケースでは複数月含まれることがあります。 items: type: string type: array @@ -18863,14 +20041,13 @@ components: - aws type: string region: - default: eu-central-1 description: | `infrastructureProvider` が `aws` の場合は、ランデブーポイントです。 - - `ap-northeast-1`: 東京 (日本) - - `eu-central-1`: フランクフルト (ドイツ) - - `us-west-2`: オレゴン (米国) - - `ap-southeast-2`: シドニー (オーストラリア) + - `ap-northeast-1`: 東京 (日本)。日本カバレッジのデフォルトです。 + - `eu-central-1`: フランクフルト (ドイツ)。グローバルカバレッジのデフォルトです。 + - `us-west-2`: オレゴン (米国)。 + - `ap-southeast-2`: シドニー (オーストラリア)。 enum: - ap-northeast-1 - eu-central-1 @@ -18883,34 +20060,50 @@ components: destination: $ref: '#/components/schemas/PortMappingDestination' duration: - description: リモートアクセスが有効になっている期間 (秒) + description: リモートアクセスが有効になっている期間 (秒)。 type: number endpoint: - description: オンデマンドリモートアクセス (IP アドレスとポート番号) + description: オンデマンドリモートアクセス (IP アドレスとポート番号)。 type: string hostname: - description: オンデマンドリモートアクセスのホスト名 + description: オンデマンドリモートアクセスのホスト名。 type: string ipAddress: - description: オンデマンドリモートアクセスの IP アドレス + description: オンデマンドリモートアクセスの IP アドレス。 type: string port: - description: オンデマンドリモートアクセスの ポート番号 + description: オンデマンドリモートアクセスの ポート番号。 type: number source: $ref: '#/components/schemas/PortMappingSource' tlsRequired: - description: TLS の有効/無効 + description: TLS の有効/無効。 type: boolean type: object PortMappingDestination: properties: imsi: - description: 対象となる IMSI + description: 対象となる IMSI。 `simId` パラメーターが指定されている場合、このパラメーターは無視されます。 type: string port: - description: デバイスが SSH 接続を待ち受けているポート番号 + description: デバイスが SSH 接続を待ち受けているポート番号。 type: number + service: + description: | + オンデマンドリモートアクセスを作成する対象を決定するためのパラメーター。`simId` パラメーターが指定されている時に有効になります。 + + - `air`: セッションがオンラインの SORACOM Air のサブスクライバー。 + - `arc`: SORACOM Arc のバーチャル SIM/Subscriber。 + + **Warning**: 何も指定しなかった場合は、セッションがオンラインのサブスクライバーが、オンデマンドリモートアクセスを作成する対象となります。セッションがオンラインのサブスクライバーが複数ある場合、つまり SORACOM Air のセッションと SORACOM Arc のセッションが両方オンラインの場合は、どちらがオンデマンドリモートアクセス作成の対象となるかは保証されません。`air` または `arc` を指定することを推奨します。 + enum: + - air + - arc + type: string + simId: + description: 対象となる SIM ID。このパラメータは `imsi` パラメーターよりも優先されます。このパラメータが指定されている場合、`service` + で指定されたパラメーターに応じてオンデマンドリモートアクセスが作成されます。 + type: string required: - imsi - port @@ -18918,7 +20111,7 @@ components: PortMappingSource: properties: ipRanges: - description: オンデマンドリモートアクセスへのアクセスを許可する CIDR 表記の IP アドレスの範囲 + description: オンデマンドリモートアクセスへのアクセスを許可する CIDR 表記の IP アドレスの範囲。 items: type: string type: array @@ -19092,18 +20285,6 @@ components: type: string type: object type: object - RegisterOperatorsRequest: - properties: - email: - type: string - password: - description: パスワードは以下の条件を満たしている必要があります：長さ 8 文字以上 100 文字以内、アルファベット小文字 (a-z) - を 1 文字以上使用、アルファベット大文字 (A-Z) を 1 文字以上使用、数字を 1 文字以上使用。記号なども使用できます。 - type: string - required: - - email - - password - type: object RegisterPayerInformationModel: properties: companyName: @@ -19146,7 +20327,20 @@ components: simInitialSettings: additionalProperties: $ref: '#/components/schemas/SimInitialSetting' - description: SIM のサブスクリプションごとの初期設定です。キーにサブスクリプションを表す文字列を指定します。 + description: | + IoT SIM のサブスクリプションごとの初期設定です。キーにサブスクリプションを表す文字列を指定します。 + + - `plan01s` + - `plan01s-low_data_volume` (plan01s - Low Data Volume) + - `planX3` (planX3 X3-5MB) + - `planP1` + - `plan-D` (plan-D (バンドルなし)、plan-D D-300MB) + - `plan-K2` (plan-K2 K2-300MB) + - `plan-DU` + - `plan-KM1` + - `plan-K` + - `plan-US` + - `plan-NA1-package` (plan-NA1) example: plan01s: groupId: 00000000-1111-2222-3333-444444444444 @@ -19207,33 +20401,33 @@ components: ResourceSummary: properties: resourceSummaryItems: - description: リソースの要約アイテムの一覧 + description: リソースの要約アイテムの一覧。 items: $ref: '#/components/schemas/ResourceSummaryItem' type: array resourceSummaryType: description: | - リソースの要約の種別 + リソースの要約の種別。 - - `simsPerStatus`: ステータスごとの IoT SIM の数 + - `simsPerStatus`: ステータスごとの IoT SIM の数。 example: simsPerStatus type: string type: object ResourceSummaryItem: properties: dimensions: - description: リソースの要約アイテムのディメンションの一覧 + description: リソースの要約アイテムのディメンションの一覧。 example: [] items: $ref: '#/components/schemas/ResourceSummaryItemDimension' type: array updatedTime: - description: リソースの要約アイテムの最終更新日時 (unixtime ミリ秒単位) + description: リソースの要約アイテムの最終更新日時 (UNIX 時間 (ミリ秒))。 example: 1654007722000 format: int64 type: integer values: - description: リソースの要約アイテムの集計値の一覧 + description: リソースの要約アイテムの集計値の一覧。 items: $ref: '#/components/schemas/ResourceSummaryItemValue' type: array @@ -19241,28 +20435,28 @@ components: ResourceSummaryItemDimension: properties: name: - description: リソースの要約アイテムのディメンションの名前 + description: リソースの要約アイテムのディメンションの名前。 type: string value: - description: リソースの要約アイテムのディメンションの値 + description: リソースの要約アイテムのディメンションの値。 type: string type: object ResourceSummaryItemValue: properties: name: description: | - リソースの要約アイテムの集計値の名前 + リソースの要約アイテムの集計値の名前。 - `resourceSummaryType` が `simsPerStatus` の場合: - - `readySims`: ステータスが「準備完了 (ready)」の IoT SIM の数 - - `activeSims`: ステータスが「使用中 (active)」の IoT SIM の数 - - `inactiveSims`: ステータスが「休止中 (inactive)」の IoT SIM の数 - - `standbySims`: ステータスが「利用開始待ち (standby)」の IoT SIM の数 - - `suspendedSims`: ステータスが「利用中断中 (suspended)」の IoT SIM の数 + - `readySims`: ステータスが「準備完了 (ready)」の IoT SIM の数。 + - `activeSims`: ステータスが「使用中 (active)」の IoT SIM の数。 + - `inactiveSims`: ステータスが「休止中 (inactive)」の IoT SIM の数。 + - `standbySims`: ステータスが「利用開始待ち (standby)」の IoT SIM の数。 + - `suspendedSims`: ステータスが「利用中断中 (suspended)」の IoT SIM の数。 example: activeSims type: string value: - description: リソースの要約アイテムの集計値の値 + description: リソースの要約アイテムの集計値の値。 example: 1 type: number type: object @@ -19274,7 +20468,7 @@ components: description: type: string permission: - description: Permission の JSON + description: パーミッションの JSON。 type: string roleId: type: string @@ -19350,23 +20544,27 @@ components: - false type: string targetOtaStatus: - description: SimSubscriptionStatusRule の時のみ有効 + description: SimSubscriptionStatusRule のときのみ有効。 enum: - started - finished - failed type: string targetSpeedClass: - description: SubscriberSpeedClassAttributeRule の時のみ有効 + description: SubscriberSpeedClassAttributeRule、SimSpeedClassAttributeRule + のときのみ有効。 enum: - s1.minimum - s1.slow - s1.standard - s1.fast - s1.4xfast + - s1.8xfast + - u1.standard + - u1.slow type: string targetStatus: - description: SubscriberStatusAttributeRule の時のみ有効 + description: SubscriberStatusAttributeRule、SimStatusAttributeRule のときのみ有効。 enum: - ready - active @@ -19488,6 +20686,10 @@ components: SetImeiLockRequest: properties: imei: + description: | + 対象デバイスの IMEI。一時的に IMEI が報告されない場合でもセッションの確立を許可する場合は、`|ANONYMOUS` を追記します。 + + たとえば、対象デバイスの IMEI が `123456789012345` の場合に `123456789012345|ANONYMOUS` を指定すると、一時的に IMEI が報告されない場合でもセッションの確立を許可します。 type: string type: object SetNetworkSetRequest: @@ -19501,6 +20703,7 @@ components: oneOf: - $ref: '#/components/schemas/OperatorConfigurationOfSupport' - $ref: '#/components/schemas/OperatorConfigurationOfEmail' + - $ref: '#/components/schemas/OperatorConfigurationOfUserConsole' expectedVersion: description: このプロパティは、更新時のコンフリクトを避けるために利用します。利用する場合、getOperatorConfigurationNamespace API で 取得した version の値をここに指定します。 もし expectedVersion を指定しなかった場合は、更新時にコンフリクトの確認をしません。 @@ -19538,7 +20741,7 @@ components: type: string type: object ShippingAddressModel: - description: お届け先 + description: 商品発送先。 properties: addressLine1: type: string @@ -19613,6 +20816,28 @@ components: format: int32 type: integer type: object + ShippingLabelDetail: + properties: + shipmentCompany: + description: 配送業者名。 + example: Yamato Transport + type: string + shipmentCompanyUrl: + description: 配送業者 URL。 + example: http://track.kuronekoyamato.co.jp/english/tracking + type: string + trackingNumber: + description: 荷物の伝票番号。 + example: 0000-1111-2222 + type: string + trackingUrl: + description: 伝票番号付きの配送状況確認 URL。 + example: https://jizen.kuronekoyamato.co.jp/jizen/servlet/crjz.b.NQ0010?id=0000-1111-2222 + type: string + required: + - shipmentCompany + - trackingNumber + type: object ShippingOptionOfExpeditedShipping: description: 米国およびカナダのオペレーターのみご利用いただけます。 properties: @@ -19627,7 +20852,7 @@ components: description: ネコポスの使用を許可する場合は true を指定します。 type: boolean shipmentCompany: - description: 運送会社 + description: 配送業者。 enum: - yamato_transport type: string @@ -19831,9 +21056,27 @@ components: description: グループ ID。 type: string speedClass: - description: |- - 速度クラス。 - - サブスクリプションにあわせた速度クラスを指定してください。 + description: | + 速度クラス。以下のいずれかを指定します。ただし、サブスクリプションにあわせた速度クラスを指定してください。 + + - plan01s、plan01s - Low Data Volume、planX3 X3-5MB、planP1、plan-D (バンドルなし)、plan-D D-300MB、plan-K2 K2-300MB、plan-K の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - plan-US の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` + - plan-DU の場合: + - `u1.standard` + - `u1.slow` + - plan-KM1 の場合: + - `t1.standard` type: string tags: additionalProperties: @@ -19862,6 +21105,31 @@ components: $ref: '#/components/schemas/SimplifiedSubscriber' type: object type: object + SimStatusHistoryResponse: + properties: + applyDateTimeEpochSec: + type: integer + bundles: + items: + type: string + type: array + groupId: + type: string + imsi: + type: string + isPrimary: + type: boolean + primaryImsi: + type: string + simId: + type: string + speedClass: + type: string + status: + type: string + subscription: + type: string + type: object SimplifiedSubscriber: properties: bundles: @@ -19902,6 +21170,178 @@ components: payload: type: string type: object + SoraCamAtomCamSettings: + properties: + logo: + description: | + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + motionTagging: + description: | + モーションタグの表示設定。モーションタグは、動いているものを検知したときに表⽰される緑の枠です。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + nightVision: + description: | + ナイトビションモードの設定。 + + - `on`: ナイトビジョンモード。 + - `off`: 通常モード。 + - `auto`: 自動切り替え。 + enum: + - "on" + - "off" + - auto + type: string + quality: + description: | + ライブ動画やクラウド録画の画質設定。なお、クラウド録画の場合は画質設定に関わらず、解像度は 1080p (1920 x 1080 ピクセル) です。 + + - `low`: ATOM アプリで「360p」を選択したときと同じ画質。 + - `medium`: ATOM アプリで「SD」を選択したときと同じ画質。 + - `high`: ATOM アプリで「HD (1080p)」を選択したときと同じ画質。 + enum: + - low + - medium + - high + type: string + rotation: + description: | + 画像を 180° 回転させる設定。ソラカメ対応カメラを上下反対に設置した場合に `180` を設定します。 + + - `0`: OFF (回転なし)。 + - `180`: ON (180° 回転)。 + enum: + - 0 + - 180 + type: integer + statusLight: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定。 + + - `on`: 点灯。 + - `off`: 消灯。 + enum: + - "on" + - "off" + type: string + timestamp: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsLogo: + properties: + state: + description: | + 撮影画像左下に表示されるアトムテック株式会社のロゴの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsMotionTagging: + properties: + state: + description: | + モーションタグの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsNightVision: + properties: + state: + description: | + ナイトビションモードの設定。 + + - `on`: ナイトビジョンモード。 + - `off`: 通常モード。 + - `auto`: 自動切り替え。 + enum: + - "on" + - "off" + - auto + type: string + type: object + SoraCamAtomCamSettingsQuality: + properties: + state: + description: | + ライブ動画やクラウド録画の画質設定。なお、クラウド録画の場合は画質設定に関わらず、解像度は 1080p (1920 x 1080 ピクセル) です。 + + - `low`: ATOM アプリで「360p」を選択したときと同じ画質。 + - `medium`: ATOM アプリで「SD」を選択したときと同じ画質。 + - `high`: ATOM アプリで「HD (1080p)」を選択したときと同じ画質。 + enum: + - low + - medium + - high + type: string + type: object + SoraCamAtomCamSettingsRotation: + properties: + state: + description: | + 画像を 180° 回転させる設定。ソラカメ対応カメラを上下反対に設置した場合に `180` を設定します。 + + - `0`: OFF (回転なし)。 + - `180`: ON (180° 回転)。 + enum: + - 0 + - 180 + type: integer + type: object + SoraCamAtomCamSettingsStatusLight: + properties: + state: + description: | + ステータスライト (カメラ本体の状態を示すランプ) の点灯設定。 + + - `on`: 点灯。 + - `off`: 消灯。 + enum: + - "on" + - "off" + type: string + type: object + SoraCamAtomCamSettingsTimestamp: + properties: + state: + description: | + 撮影画像右下に表示されるタイムスタンプの表示設定。 + + - `on`: 表示。 + - `off`: 非表示。 + enum: + - "on" + - "off" + type: string + type: object SoraCamDevice: properties: appliedLicenses: @@ -19971,6 +21411,11 @@ components: - `storage_life`: 保存期間 type: string type: object + SoraCamDeviceName: + properties: + name: + type: string + type: object SoraCamEvent: properties: deviceId: @@ -20143,12 +21588,12 @@ components: SoraCamLicensePackQuantityUpdatingRequest: properties: currentQuantity: - description: 現在のライセンス数 + description: 現在のライセンス数。 example: 1 format: int32 type: integer desiredQuantity: - description: 変更後のライセンス数 + description: 変更後のライセンス数。 example: 2 format: int32 type: integer @@ -20156,20 +21601,20 @@ components: SoraCamLicensePackResponse: properties: id: - description: ライセンスパックの ID + description: ライセンスパックの ID。 example: CR7-SC type: string name: - description: ライセンスパックの名前 + description: ライセンスパックの名前。 example: Cloud Recording License (7 Days) type: string quantity: - description: 現在のライセンス数 + description: 現在のライセンス数。 example: 1 format: int32 type: integer salesChannel: - description: ライセンスパックの販売元 + description: ライセンスパックの販売元。 example: SORACOM Inc. type: string type: object @@ -20193,6 +21638,60 @@ components: - 録画映像を取得しようとした場合に、指定した `from` から `to` の間に録画映像が存在しない。 type: string type: object + SoraCamPowerState: + properties: + powerState: + description: | + ソラカメ対応カメラの電源状態。 + + - `on`: 電源オン + - `sleep`: スリープ + enum: + - "on" + - sleep + type: string + type: object + SoraCamRecordingsAndEventsList: + properties: + events: + items: + properties: + endTime: + description: イベントの終了時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + startTime: + description: イベントの開始時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + type: + description: | + イベント種別。 + + - `motion`: モーション検知。 + - `sound`: サウンド検出。 + - `other`: その他。 + enum: + - motion + - sound + - other + type: string + type: object + type: array + records: + items: + properties: + endTime: + description: 録画の終了時刻 (UNIX 時間 (ミリ秒))。録画中の場合は、`endTime` が含まれません。 + format: int64 + type: integer + startTime: + description: 録画の開始時刻 (UNIX 時間 (ミリ秒))。 + format: int64 + type: integer + type: object + type: array + type: object SoraCamStreamingVideo: properties: expiryTime: @@ -20604,7 +22103,7 @@ components: type: string type: array type: - description: 通知種別 + description: メールアドレスの種類。 enum: - primary - recovery @@ -20618,12 +22117,7 @@ components: TagSet: additionalProperties: type: string - description: An object which always contains at least one property "name" with - a string value. If you give a subscriber/SIM a name, the name will be returned - as the value of the "name" property. If the subscriber/SIM does not have a - name, an empty string "" is returned. In addition, if you create any custom - tags for the subscriber/SIM, each custom tag will appear as additional properties - in the object. + description: 任意のタグを設定できます。name プロパティに指定した値が、IoT SIM やグループなどのオブジェクトの名前として扱われます。 example: tagName1: tagValue1 tagName2: tagValue2... @@ -20676,17 +22170,25 @@ components: speedClass: description: | 速度クラス。以下のいずれかを指定します。ただし、サブスクリプションにあわせた速度クラスを指定してください。 - - plan01s、plan01s - Low Data Volume、planP1、planX3 X3-5MB、plan-D の場合: + + - plan01s、plan01s - Low Data Volume、planX3 X3-5MB、planP1、plan-D (バンドルなし)、plan-D D-300MB、plan-K2 K2-300MB、plan-K の場合: - `s1.minimum` - `s1.slow` - `s1.standard` - `s1.fast` - `s1.4xfast` - - plan-KM1 の場合: - - `t1.standard` + - plan-US の場合: + - `s1.minimum` + - `s1.slow` + - `s1.standard` + - `s1.fast` + - `s1.4xfast` + - `s1.8xfast` - plan-DU の場合: - `u1.standard` - `u1.slow` + - plan-KM1 の場合: + - `t1.standard` - バーチャル SIM/Subscriber の場合: - `arc.standard` enum: @@ -20695,9 +22197,10 @@ components: - s1.standard - s1.fast - s1.4xfast - - t1.standard + - s1.8xfast - u1.standard - u1.slow + - t1.standard - arc.standard type: string required: @@ -20736,14 +22239,7 @@ components: VerifyAddEmailTokenRequest: properties: token: - description: メールで送信されたトークン - type: string - required: - - token - type: object - VerifyOperatorsRequest: - properties: - token: + description: メールで送信されたトークン。 type: string required: - token @@ -20814,21 +22310,22 @@ components: placement: $ref: '#/components/schemas/Placement' primaryServiceName: - description: (非推奨) + description: (非推奨) このプロパティは使用されていません。 type: string sessionStats: properties: lastUpdatedAt: - description: セッション数の集計日時 (UNIX 時間 (ミリ秒))。なお、オンラインのセッション数は定期的に集計しているため、リアルタイムの数値ではありません。 + description: セッション数の集計日時 (UNIX 時間 (ミリ秒))。 format: int64 type: integer online: description: VPG を利用する IoT SIM とバーチャル SIM/Subscriber のうち、セッションが "オンライン" - になっている IoT SIM とバーチャル SIM/Subscriber の数。 + になっている IoT SIM とバーチャル SIM/Subscriber の数。なお、オンラインのセッション数は定期的に集計しているため、リアルタイムの数値ではありません。この数値が更新された日時は、lastUpdatedAt + で確認できます。 type: integer type: object size: - description: (非推奨) VPG サイズ + description: (非推奨) このプロパティは使用されていません。 type: string status: enum: @@ -20866,7 +22363,7 @@ components: description: ID type: string vpgSubnetCidrRange: - description: VPG IP アドレスレンジ。VPG に割り当てられる IP アドレスの範囲です。 + description: VPG に割り当てられる IP アドレスの範囲です。SORACOM Door または SORACOM Direct を利用する際に必要です。 type: string type: object VolumeDiscountModel: @@ -20980,7 +22477,7 @@ tags: name: DeviceObjectModel - description: '[SORACOM Inventory デバイス](/ja-jp/docs/inventory/)' name: Device -- description: '[診断機能](/ja-jp/docs/diagnostic/)' +- description: '[診断機能](/ja-jp/guides/diagnostic/)' name: Diagnostic - description: '[イベントハンドラー](/ja-jp/docs/event-handler/)' name: EventHandler diff --git a/soracom/generated/cmd/audit_logs_api_get.go b/soracom/generated/cmd/audit_logs_api_get.go index 86d16b7f..5375e0f1 100644 --- a/soracom/generated/cmd/audit_logs_api_get.go +++ b/soracom/generated/cmd/audit_logs_api_get.go @@ -31,7 +31,7 @@ var AuditLogsApiGetCmdPaginate bool var AuditLogsApiGetCmdOutputJSONL bool func InitAuditLogsApiGetCmd() { - AuditLogsApiGetCmd.Flags().StringVar(&AuditLogsApiGetCmdApiKind, "api-kind", "", TRAPI("Filter item for audit log retrieval by API kind.")) + AuditLogsApiGetCmd.Flags().StringVar(&AuditLogsApiGetCmdApiKind, "api-kind", "", TRAPI("Filter item for audit log retrieval by API kind (e.g. '/v1/auth').")) AuditLogsApiGetCmd.Flags().StringVar(&AuditLogsApiGetCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The value of 'requestedTimeEpochMs' in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page onward.")) diff --git a/soracom/generated/cmd/audit_logs_napter_get.go b/soracom/generated/cmd/audit_logs_napter_get.go index bbd9815d..ad17bb5c 100644 --- a/soracom/generated/cmd/audit_logs_napter_get.go +++ b/soracom/generated/cmd/audit_logs_napter_get.go @@ -38,7 +38,7 @@ func InitAuditLogsNapterGetCmd() { AuditLogsNapterGetCmd.Flags().StringVar(&AuditLogsNapterGetCmdResourceId, "resource-id", "", TRAPI("Identity of the target resource to query log entries.")) - AuditLogsNapterGetCmd.Flags().StringVar(&AuditLogsNapterGetCmdResourceType, "resource-type", "", TRAPI("Type of the target resource to query Napter audit log entries.")) + AuditLogsNapterGetCmd.Flags().StringVar(&AuditLogsNapterGetCmdResourceType, "resource-type", "", TRAPI("Type of the target resource to query log entries.")) AuditLogsNapterGetCmd.Flags().Int64Var(&AuditLogsNapterGetCmdFrom, "from", 0, TRAPI("Start time for the log search range (unixtime milliseconds).")) diff --git a/soracom/generated/cmd/bills_export_latest.go b/soracom/generated/cmd/bills_export_latest.go index f1bfa395..7ac6ccfc 100644 --- a/soracom/generated/cmd/bills_export_latest.go +++ b/soracom/generated/cmd/bills_export_latest.go @@ -13,7 +13,7 @@ import ( var BillsExportLatestCmdExportMode string func InitBillsExportLatestCmd() { - BillsExportLatestCmd.Flags().StringVar(&BillsExportLatestCmdExportMode, "export-mode", "", TRAPI("export_mode (async, sync)")) + BillsExportLatestCmd.Flags().StringVar(&BillsExportLatestCmdExportMode, "export-mode", "", TRAPI("Specify how to get the URL to download the billing details CSV.- 'async': Get the 'exportedFieldId' without waiting for the URL to be issued on the SORACOM platform. Specify this 'exportedFieldId' in ['Files:getExportedFile API'](#/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use 'async'.- 'sync' (default): Wait for the URL to be issued on the SORACOM platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify 'async'.")) BillsExportLatestCmd.RunE = BillsExportLatestCmdRunE diff --git a/soracom/generated/cmd/cell_locations_get.go b/soracom/generated/cmd/cell_locations_get.go index 3d3f04bb..19685736 100644 --- a/soracom/generated/cmd/cell_locations_get.go +++ b/soracom/generated/cmd/cell_locations_get.go @@ -31,19 +31,19 @@ var CellLocationsGetCmdMnc string var CellLocationsGetCmdTac string func InitCellLocationsGetCmd() { - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdCid, "cid", "", TRAPI("CID - Cell ID (for 3G)")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdCid, "cid", "", TRAPI("CID - Cell ID (for 3G).")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdEci, "eci", "", TRAPI("ECID - Enhanced Cell ID (for 4G) - specify either 'ecid' or 'eci'")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdEci, "eci", "", TRAPI("ECID - Enhanced Cell ID (for 4G) - specify either 'ecid' or 'eci'. The result is the same regardless of which value is specified.")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdEcid, "ecid", "", TRAPI("ECID - Enhanced Cell ID (for 4G) - specify either 'ecid' or 'eci'")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdEcid, "ecid", "", TRAPI("ECID - Enhanced Cell ID (for 4G) - specify either 'ecid' or 'eci'. The result is the same regardless of which value is specified.")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdLac, "lac", "", TRAPI("LAC - Location Area Code (for 3G)")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdLac, "lac", "", TRAPI("LAC - Location Area Code (for 3G).")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdMcc, "mcc", "", TRAPI("MCC - Mobile Country Code")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdMcc, "mcc", "", TRAPI("MCC - Mobile Country Code.")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdMnc, "mnc", "", TRAPI("MNC - Mobile Network Code")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdMnc, "mnc", "", TRAPI("MNC - Mobile Network Code.")) - CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdTac, "tac", "", TRAPI("TAC - Tracking Area Code (for 4G)")) + CellLocationsGetCmd.Flags().StringVar(&CellLocationsGetCmdTac, "tac", "", TRAPI("TAC - Tracking Area Code (for 4G).")) CellLocationsGetCmd.RunE = CellLocationsGetCmdRunE diff --git a/soracom/generated/cmd/coupons_create.go b/soracom/generated/cmd/coupons_create.go index f6416e28..b2200b18 100644 --- a/soracom/generated/cmd/coupons_create.go +++ b/soracom/generated/cmd/coupons_create.go @@ -20,7 +20,7 @@ var CouponsCreateCmdAmount float64 var CouponsCreateCmdBody string func InitCouponsCreateCmd() { - CouponsCreateCmd.Flags().Float64Var(&CouponsCreateCmdAmount, "amount", 0, TRAPI("Amount")) + CouponsCreateCmd.Flags().Float64Var(&CouponsCreateCmdAmount, "amount", 0, TRAPI("Amount.")) CouponsCreateCmd.Flags().StringVar(&CouponsCreateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/coupons_register.go b/soracom/generated/cmd/coupons_register.go index 7f88f268..75ed9323 100644 --- a/soracom/generated/cmd/coupons_register.go +++ b/soracom/generated/cmd/coupons_register.go @@ -13,7 +13,7 @@ import ( var CouponsRegisterCmdCouponCode string func InitCouponsRegisterCmd() { - CouponsRegisterCmd.Flags().StringVar(&CouponsRegisterCmdCouponCode, "coupon-code", "", TRAPI("Coupon code")) + CouponsRegisterCmd.Flags().StringVar(&CouponsRegisterCmdCouponCode, "coupon-code", "", TRAPI("Coupon code.")) CouponsRegisterCmd.RunE = CouponsRegisterCmdRunE diff --git a/soracom/generated/cmd/credentials_create.go b/soracom/generated/cmd/credentials_create.go index 83873590..35e5d570 100644 --- a/soracom/generated/cmd/credentials_create.go +++ b/soracom/generated/cmd/credentials_create.go @@ -26,7 +26,7 @@ var CredentialsCreateCmdType string var CredentialsCreateCmdBody string func InitCredentialsCreateCmd() { - CredentialsCreateCmd.Flags().StringVar(&CredentialsCreateCmdCredentialsId, "credentials-id", "", TRAPI("credentials_id")) + CredentialsCreateCmd.Flags().StringVar(&CredentialsCreateCmdCredentialsId, "credentials-id", "", TRAPI("Credentials set ID.")) CredentialsCreateCmd.Flags().StringVar(&CredentialsCreateCmdDescription, "description", "", TRAPI("")) diff --git a/soracom/generated/cmd/credentials_delete.go b/soracom/generated/cmd/credentials_delete.go index d3c3e452..a0ecefcb 100644 --- a/soracom/generated/cmd/credentials_delete.go +++ b/soracom/generated/cmd/credentials_delete.go @@ -13,7 +13,7 @@ import ( var CredentialsDeleteCmdCredentialsId string func InitCredentialsDeleteCmd() { - CredentialsDeleteCmd.Flags().StringVar(&CredentialsDeleteCmdCredentialsId, "credentials-id", "", TRAPI("Credentials ID")) + CredentialsDeleteCmd.Flags().StringVar(&CredentialsDeleteCmdCredentialsId, "credentials-id", "", TRAPI("Credentials set ID.")) CredentialsDeleteCmd.RunE = CredentialsDeleteCmdRunE diff --git a/soracom/generated/cmd/credentials_update.go b/soracom/generated/cmd/credentials_update.go index e35bd5cf..a5cfbce3 100644 --- a/soracom/generated/cmd/credentials_update.go +++ b/soracom/generated/cmd/credentials_update.go @@ -26,7 +26,7 @@ var CredentialsUpdateCmdType string var CredentialsUpdateCmdBody string func InitCredentialsUpdateCmd() { - CredentialsUpdateCmd.Flags().StringVar(&CredentialsUpdateCmdCredentialsId, "credentials-id", "", TRAPI("credentials_id")) + CredentialsUpdateCmd.Flags().StringVar(&CredentialsUpdateCmdCredentialsId, "credentials-id", "", TRAPI("Credentials set ID.")) CredentialsUpdateCmd.Flags().StringVar(&CredentialsUpdateCmdDescription, "description", "", TRAPI("")) diff --git a/soracom/generated/cmd/data_get.go b/soracom/generated/cmd/data_get.go index 94f9b94a..f1463ffd 100644 --- a/soracom/generated/cmd/data_get.go +++ b/soracom/generated/cmd/data_get.go @@ -42,7 +42,7 @@ func InitDataGetCmd() { DataGetCmd.Flags().Int64Var(&DataGetCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - DataGetCmd.Flags().Int64Var(&DataGetCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve. The default is '10'.")) + DataGetCmd.Flags().Int64Var(&DataGetCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) DataGetCmd.Flags().Int64Var(&DataGetCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/data_get_entries.go b/soracom/generated/cmd/data_get_entries.go index 85f24602..6bfed8fc 100644 --- a/soracom/generated/cmd/data_get_entries.go +++ b/soracom/generated/cmd/data_get_entries.go @@ -47,7 +47,7 @@ func InitDataGetEntriesCmd() { DataGetEntriesCmd.Flags().Int64Var(&DataGetEntriesCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - DataGetEntriesCmd.Flags().Int64Var(&DataGetEntriesCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve. The default is '10'.")) + DataGetEntriesCmd.Flags().Int64Var(&DataGetEntriesCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) DataGetEntriesCmd.Flags().Int64Var(&DataGetEntriesCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/devices_get_data.go b/soracom/generated/cmd/devices_get_data.go index 083c3f6f..c0435311 100644 --- a/soracom/generated/cmd/devices_get_data.go +++ b/soracom/generated/cmd/devices_get_data.go @@ -42,7 +42,7 @@ func InitDevicesGetDataCmd() { DevicesGetDataCmd.Flags().Int64Var(&DevicesGetDataCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - DevicesGetDataCmd.Flags().Int64Var(&DevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve.")) + DevicesGetDataCmd.Flags().Int64Var(&DevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) DevicesGetDataCmd.Flags().Int64Var(&DevicesGetDataCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/diagnostics_send_request.go b/soracom/generated/cmd/diagnostics_send_request.go index b1444a2e..e4545dde 100644 --- a/soracom/generated/cmd/diagnostics_send_request.go +++ b/soracom/generated/cmd/diagnostics_send_request.go @@ -35,15 +35,15 @@ var DiagnosticsSendRequestCmdOutputJSONL bool var DiagnosticsSendRequestCmdBody string func InitDiagnosticsSendRequestCmd() { - DiagnosticsSendRequestCmd.Flags().StringVar(&DiagnosticsSendRequestCmdResourceId, "resource-id", "", TRAPI("resourceId according to resourceType")) + DiagnosticsSendRequestCmd.Flags().StringVar(&DiagnosticsSendRequestCmdResourceId, "resource-id", "", TRAPI("Identifier according to resourceType.- If resourceType is 'sim', specify the SIM ID.")) DiagnosticsSendRequestCmd.Flags().StringVar(&DiagnosticsSendRequestCmdResourceType, "resource-type", "", TRAPI("")) DiagnosticsSendRequestCmd.Flags().StringVar(&DiagnosticsSendRequestCmdService, "service", "", TRAPI("")) - DiagnosticsSendRequestCmd.Flags().Int64Var(&DiagnosticsSendRequestCmdFrom, "from", 0, TRAPI("Start time for diagnostic (unixtime milliseconds)")) + DiagnosticsSendRequestCmd.Flags().Int64Var(&DiagnosticsSendRequestCmdFrom, "from", 0, TRAPI("Start time for diagnostic (UNIX time in milliseconds).")) - DiagnosticsSendRequestCmd.Flags().Int64Var(&DiagnosticsSendRequestCmdTo, "to", 0, TRAPI("End time for diagnostic (unixtime milliseconds)")) + DiagnosticsSendRequestCmd.Flags().Int64Var(&DiagnosticsSendRequestCmdTo, "to", 0, TRAPI("End time for diagnostic (UNIX time in milliseconds).")) DiagnosticsSendRequestCmd.Flags().BoolVar(&DiagnosticsSendRequestCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/emails_delete.go b/soracom/generated/cmd/emails_delete.go index b3b690c0..13821b4a 100644 --- a/soracom/generated/cmd/emails_delete.go +++ b/soracom/generated/cmd/emails_delete.go @@ -16,9 +16,9 @@ var EmailsDeleteCmdEmailId string var EmailsDeleteCmdOperatorId string func InitEmailsDeleteCmd() { - EmailsDeleteCmd.Flags().StringVar(&EmailsDeleteCmdEmailId, "email-id", "", TRAPI("email_id")) + EmailsDeleteCmd.Flags().StringVar(&EmailsDeleteCmdEmailId, "email-id", "", TRAPI("Email address ID.")) - EmailsDeleteCmd.Flags().StringVar(&EmailsDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + EmailsDeleteCmd.Flags().StringVar(&EmailsDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) EmailsDeleteCmd.RunE = EmailsDeleteCmdRunE diff --git a/soracom/generated/cmd/emails_get.go b/soracom/generated/cmd/emails_get.go index e3eed214..090046c8 100644 --- a/soracom/generated/cmd/emails_get.go +++ b/soracom/generated/cmd/emails_get.go @@ -16,9 +16,9 @@ var EmailsGetCmdEmailId string var EmailsGetCmdOperatorId string func InitEmailsGetCmd() { - EmailsGetCmd.Flags().StringVar(&EmailsGetCmdEmailId, "email-id", "", TRAPI("email_id")) + EmailsGetCmd.Flags().StringVar(&EmailsGetCmdEmailId, "email-id", "", TRAPI("Email address ID.")) - EmailsGetCmd.Flags().StringVar(&EmailsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + EmailsGetCmd.Flags().StringVar(&EmailsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) EmailsGetCmd.RunE = EmailsGetCmdRunE diff --git a/soracom/generated/cmd/emails_issue_add_email_token.go b/soracom/generated/cmd/emails_issue_add_email_token.go index d726c49d..9cff124a 100644 --- a/soracom/generated/cmd/emails_issue_add_email_token.go +++ b/soracom/generated/cmd/emails_issue_add_email_token.go @@ -23,9 +23,9 @@ var EmailsIssueAddEmailTokenCmdPassword string var EmailsIssueAddEmailTokenCmdBody string func InitEmailsIssueAddEmailTokenCmd() { - EmailsIssueAddEmailTokenCmd.Flags().StringVar(&EmailsIssueAddEmailTokenCmdEmail, "email", "", TRAPI("Email address to be added")) + EmailsIssueAddEmailTokenCmd.Flags().StringVar(&EmailsIssueAddEmailTokenCmdEmail, "email", "", TRAPI("Email address to be added.")) - EmailsIssueAddEmailTokenCmd.Flags().StringVar(&EmailsIssueAddEmailTokenCmdPassword, "password", "", TRAPI("Password of the operator")) + EmailsIssueAddEmailTokenCmd.Flags().StringVar(&EmailsIssueAddEmailTokenCmdPassword, "password", "", TRAPI("Password of the root user.")) EmailsIssueAddEmailTokenCmd.Flags().StringVar(&EmailsIssueAddEmailTokenCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/emails_list.go b/soracom/generated/cmd/emails_list.go index bb59e0ce..27180cb4 100644 --- a/soracom/generated/cmd/emails_list.go +++ b/soracom/generated/cmd/emails_list.go @@ -16,7 +16,7 @@ var EmailsListCmdOperatorId string var EmailsListCmdOutputJSONL bool func InitEmailsListCmd() { - EmailsListCmd.Flags().StringVar(&EmailsListCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + EmailsListCmd.Flags().StringVar(&EmailsListCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) EmailsListCmd.Flags().BoolVar(&EmailsListCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/emails_verify_add_email_token.go b/soracom/generated/cmd/emails_verify_add_email_token.go index c1b4ef56..7131fda2 100644 --- a/soracom/generated/cmd/emails_verify_add_email_token.go +++ b/soracom/generated/cmd/emails_verify_add_email_token.go @@ -20,7 +20,7 @@ var EmailsVerifyAddEmailTokenCmdToken string var EmailsVerifyAddEmailTokenCmdBody string func InitEmailsVerifyAddEmailTokenCmd() { - EmailsVerifyAddEmailTokenCmd.Flags().StringVar(&EmailsVerifyAddEmailTokenCmdToken, "token", "", TRAPI("Token sent by email")) + EmailsVerifyAddEmailTokenCmd.Flags().StringVar(&EmailsVerifyAddEmailTokenCmdToken, "token", "", TRAPI("Token sent by email.")) EmailsVerifyAddEmailTokenCmd.Flags().StringVar(&EmailsVerifyAddEmailTokenCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/event_handlers_delete.go b/soracom/generated/cmd/event_handlers_delete.go index 8384dcc1..351fb7bb 100644 --- a/soracom/generated/cmd/event_handlers_delete.go +++ b/soracom/generated/cmd/event_handlers_delete.go @@ -13,7 +13,7 @@ import ( var EventHandlersDeleteCmdHandlerId string func InitEventHandlersDeleteCmd() { - EventHandlersDeleteCmd.Flags().StringVar(&EventHandlersDeleteCmdHandlerId, "handler-id", "", TRAPI("handler ID")) + EventHandlersDeleteCmd.Flags().StringVar(&EventHandlersDeleteCmdHandlerId, "handler-id", "", TRAPI("Event handler ID.")) EventHandlersDeleteCmd.RunE = EventHandlersDeleteCmdRunE diff --git a/soracom/generated/cmd/event_handlers_get.go b/soracom/generated/cmd/event_handlers_get.go index d125f8c1..7ab1acbb 100644 --- a/soracom/generated/cmd/event_handlers_get.go +++ b/soracom/generated/cmd/event_handlers_get.go @@ -13,7 +13,7 @@ import ( var EventHandlersGetCmdHandlerId string func InitEventHandlersGetCmd() { - EventHandlersGetCmd.Flags().StringVar(&EventHandlersGetCmdHandlerId, "handler-id", "", TRAPI("handler ID")) + EventHandlersGetCmd.Flags().StringVar(&EventHandlersGetCmdHandlerId, "handler-id", "", TRAPI("Event handler ID.")) EventHandlersGetCmd.RunE = EventHandlersGetCmdRunE diff --git a/soracom/generated/cmd/event_handlers_ignore.go b/soracom/generated/cmd/event_handlers_ignore.go index 76e60c25..82cf032c 100644 --- a/soracom/generated/cmd/event_handlers_ignore.go +++ b/soracom/generated/cmd/event_handlers_ignore.go @@ -16,9 +16,9 @@ var EventHandlersIgnoreCmdHandlerId string var EventHandlersIgnoreCmdImsi string func InitEventHandlersIgnoreCmd() { - EventHandlersIgnoreCmd.Flags().StringVar(&EventHandlersIgnoreCmdHandlerId, "handler-id", "", TRAPI("handler_id")) + EventHandlersIgnoreCmd.Flags().StringVar(&EventHandlersIgnoreCmdHandlerId, "handler-id", "", TRAPI("Event handler ID.")) - EventHandlersIgnoreCmd.Flags().StringVar(&EventHandlersIgnoreCmdImsi, "imsi", "", TRAPI("imsi")) + EventHandlersIgnoreCmd.Flags().StringVar(&EventHandlersIgnoreCmdImsi, "imsi", "", TRAPI("IMSI.")) EventHandlersIgnoreCmd.RunE = EventHandlersIgnoreCmdRunE diff --git a/soracom/generated/cmd/event_handlers_list.go b/soracom/generated/cmd/event_handlers_list.go index 62d9a954..67a200af 100644 --- a/soracom/generated/cmd/event_handlers_list.go +++ b/soracom/generated/cmd/event_handlers_list.go @@ -16,7 +16,7 @@ var EventHandlersListCmdTarget string var EventHandlersListCmdOutputJSONL bool func InitEventHandlersListCmd() { - EventHandlersListCmd.Flags().StringVar(&EventHandlersListCmdTarget, "target", "", TRAPI("target")) + EventHandlersListCmd.Flags().StringVar(&EventHandlersListCmdTarget, "target", "", TRAPI("The event handler target (the target for executing events).")) EventHandlersListCmd.Flags().BoolVar(&EventHandlersListCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/event_handlers_list_for_subscriber.go b/soracom/generated/cmd/event_handlers_list_for_subscriber.go index ef25fa1a..7ce39ced 100644 --- a/soracom/generated/cmd/event_handlers_list_for_subscriber.go +++ b/soracom/generated/cmd/event_handlers_list_for_subscriber.go @@ -16,7 +16,7 @@ var EventHandlersListForSubscriberCmdImsi string var EventHandlersListForSubscriberCmdOutputJSONL bool func InitEventHandlersListForSubscriberCmd() { - EventHandlersListForSubscriberCmd.Flags().StringVar(&EventHandlersListForSubscriberCmdImsi, "imsi", "", TRAPI("imsi")) + EventHandlersListForSubscriberCmd.Flags().StringVar(&EventHandlersListForSubscriberCmdImsi, "imsi", "", TRAPI("IMSI.")) EventHandlersListForSubscriberCmd.Flags().BoolVar(&EventHandlersListForSubscriberCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/event_handlers_unignore.go b/soracom/generated/cmd/event_handlers_unignore.go index fa970e3b..3601b796 100644 --- a/soracom/generated/cmd/event_handlers_unignore.go +++ b/soracom/generated/cmd/event_handlers_unignore.go @@ -16,9 +16,9 @@ var EventHandlersUnignoreCmdHandlerId string var EventHandlersUnignoreCmdImsi string func InitEventHandlersUnignoreCmd() { - EventHandlersUnignoreCmd.Flags().StringVar(&EventHandlersUnignoreCmdHandlerId, "handler-id", "", TRAPI("handler_id")) + EventHandlersUnignoreCmd.Flags().StringVar(&EventHandlersUnignoreCmdHandlerId, "handler-id", "", TRAPI("Event handler ID.")) - EventHandlersUnignoreCmd.Flags().StringVar(&EventHandlersUnignoreCmdImsi, "imsi", "", TRAPI("imsi")) + EventHandlersUnignoreCmd.Flags().StringVar(&EventHandlersUnignoreCmdImsi, "imsi", "", TRAPI("IMSI.")) EventHandlersUnignoreCmd.RunE = EventHandlersUnignoreCmdRunE diff --git a/soracom/generated/cmd/event_handlers_update.go b/soracom/generated/cmd/event_handlers_update.go index f5dcc93b..8e5209d3 100644 --- a/soracom/generated/cmd/event_handlers_update.go +++ b/soracom/generated/cmd/event_handlers_update.go @@ -43,7 +43,7 @@ var EventHandlersUpdateCmdBody string func InitEventHandlersUpdateCmd() { EventHandlersUpdateCmd.Flags().StringVar(&EventHandlersUpdateCmdDescription, "description", "", TRAPI("")) - EventHandlersUpdateCmd.Flags().StringVar(&EventHandlersUpdateCmdHandlerId, "handler-id", "", TRAPI("handler ID")) + EventHandlersUpdateCmd.Flags().StringVar(&EventHandlersUpdateCmdHandlerId, "handler-id", "", TRAPI("Event handler ID.")) EventHandlersUpdateCmd.Flags().StringVar(&EventHandlersUpdateCmdName, "name", "", TRAPI("")) diff --git a/soracom/generated/cmd/gadgets_delete_tag.go b/soracom/generated/cmd/gadgets_delete_tag.go index 521db21f..0e92a7ba 100644 --- a/soracom/generated/cmd/gadgets_delete_tag.go +++ b/soracom/generated/cmd/gadgets_delete_tag.go @@ -19,9 +19,9 @@ var GadgetsDeleteTagCmdSerialNumber string var GadgetsDeleteTagCmdTagName string func InitGadgetsDeleteTagCmd() { - GadgetsDeleteTagCmd.Flags().StringVar(&GadgetsDeleteTagCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsDeleteTagCmd.Flags().StringVar(&GadgetsDeleteTagCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsDeleteTagCmd.Flags().StringVar(&GadgetsDeleteTagCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsDeleteTagCmd.Flags().StringVar(&GadgetsDeleteTagCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsDeleteTagCmd.Flags().StringVar(&GadgetsDeleteTagCmdTagName, "tag-name", "", TRAPI("Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) diff --git a/soracom/generated/cmd/gadgets_disable_termination.go b/soracom/generated/cmd/gadgets_disable_termination.go index 92cdc9d8..78138e3e 100644 --- a/soracom/generated/cmd/gadgets_disable_termination.go +++ b/soracom/generated/cmd/gadgets_disable_termination.go @@ -16,9 +16,9 @@ var GadgetsDisableTerminationCmdProductId string var GadgetsDisableTerminationCmdSerialNumber string func InitGadgetsDisableTerminationCmd() { - GadgetsDisableTerminationCmd.Flags().StringVar(&GadgetsDisableTerminationCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsDisableTerminationCmd.Flags().StringVar(&GadgetsDisableTerminationCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsDisableTerminationCmd.Flags().StringVar(&GadgetsDisableTerminationCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsDisableTerminationCmd.Flags().StringVar(&GadgetsDisableTerminationCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsDisableTerminationCmd.RunE = GadgetsDisableTerminationCmdRunE diff --git a/soracom/generated/cmd/gadgets_enable_termination.go b/soracom/generated/cmd/gadgets_enable_termination.go index 8921d2a6..c48a5519 100644 --- a/soracom/generated/cmd/gadgets_enable_termination.go +++ b/soracom/generated/cmd/gadgets_enable_termination.go @@ -16,9 +16,9 @@ var GadgetsEnableTerminationCmdProductId string var GadgetsEnableTerminationCmdSerialNumber string func InitGadgetsEnableTerminationCmd() { - GadgetsEnableTerminationCmd.Flags().StringVar(&GadgetsEnableTerminationCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsEnableTerminationCmd.Flags().StringVar(&GadgetsEnableTerminationCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsEnableTerminationCmd.Flags().StringVar(&GadgetsEnableTerminationCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsEnableTerminationCmd.Flags().StringVar(&GadgetsEnableTerminationCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsEnableTerminationCmd.RunE = GadgetsEnableTerminationCmdRunE diff --git a/soracom/generated/cmd/gadgets_get.go b/soracom/generated/cmd/gadgets_get.go index 05cf9409..b59c1a55 100644 --- a/soracom/generated/cmd/gadgets_get.go +++ b/soracom/generated/cmd/gadgets_get.go @@ -16,9 +16,9 @@ var GadgetsGetCmdProductId string var GadgetsGetCmdSerialNumber string func InitGadgetsGetCmd() { - GadgetsGetCmd.Flags().StringVar(&GadgetsGetCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsGetCmd.Flags().StringVar(&GadgetsGetCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsGetCmd.Flags().StringVar(&GadgetsGetCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsGetCmd.Flags().StringVar(&GadgetsGetCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsGetCmd.RunE = GadgetsGetCmdRunE diff --git a/soracom/generated/cmd/gadgets_list.go b/soracom/generated/cmd/gadgets_list.go index f3e6660f..54bdffb7 100644 --- a/soracom/generated/cmd/gadgets_list.go +++ b/soracom/generated/cmd/gadgets_list.go @@ -34,17 +34,17 @@ var GadgetsListCmdPaginate bool var GadgetsListCmdOutputJSONL bool func InitGadgetsListCmd() { - GadgetsListCmd.Flags().StringVar(&GadgetsListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The ID ({product_id}/{serial_number}) of the last gadget retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device onward.")) + GadgetsListCmd.Flags().StringVar(&GadgetsListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The ID ('{product_id}/{serial_number}') of the last gadget retrieved on the previous page in URL encoding (percent encoding).By specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward.The value of the 'last_evaluated_key' of 'rel=next' returned in the 'link' header when the API is called is expected to be specified in the next call, but any ID ('{productId}/{serialNumber}') can be specified.")) - GadgetsListCmd.Flags().StringVar(&GadgetsListCmdProductId, "product-id", "", TRAPI("Product ID for filtering the search.")) + GadgetsListCmd.Flags().StringVar(&GadgetsListCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device for filtering the search.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagName, "tag-name", "", TRAPI("Tag name for filtering the search (exact match).")) + GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagName, "tag-name", "", TRAPI("Tag name for filtering the search. The search is always an exact match, regardless of the setting of 'tag_value_match_mode'.")) - GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagValue, "tag-value", "", TRAPI("Tag search string for filtering the search. Required when 'tag_name' has been specified.")) + GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagValue, "tag-value", "", TRAPI("Specifies a tag value to search for in a URL-encoded (percent-encoded) string. Required when 'tag_name' has been specified.")) - GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Tag match mode.")) + GadgetsListCmd.Flags().StringVar(&GadgetsListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Tag match mode.- 'exact': exact match.- 'prefix': prefix match.")) - GadgetsListCmd.Flags().Int64Var(&GadgetsListCmdLimit, "limit", 0, TRAPI("Maximum number of gadgets to retrieve.")) + GadgetsListCmd.Flags().Int64Var(&GadgetsListCmdLimit, "limit", 0, TRAPI("Maximum number of Gadget API compatible devices data to retrieve.")) GadgetsListCmd.Flags().BoolVar(&GadgetsListCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/gadgets_put_tags.go b/soracom/generated/cmd/gadgets_put_tags.go index 9f738b63..1a73659e 100644 --- a/soracom/generated/cmd/gadgets_put_tags.go +++ b/soracom/generated/cmd/gadgets_put_tags.go @@ -23,9 +23,9 @@ var GadgetsPutTagsCmdSerialNumber string var GadgetsPutTagsCmdBody string func InitGadgetsPutTagsCmd() { - GadgetsPutTagsCmd.Flags().StringVar(&GadgetsPutTagsCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsPutTagsCmd.Flags().StringVar(&GadgetsPutTagsCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsPutTagsCmd.Flags().StringVar(&GadgetsPutTagsCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsPutTagsCmd.Flags().StringVar(&GadgetsPutTagsCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsPutTagsCmd.Flags().StringVar(&GadgetsPutTagsCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/gadgets_register.go b/soracom/generated/cmd/gadgets_register.go index 19218242..107ae503 100644 --- a/soracom/generated/cmd/gadgets_register.go +++ b/soracom/generated/cmd/gadgets_register.go @@ -23,9 +23,9 @@ var GadgetsRegisterCmdSerialNumber string var GadgetsRegisterCmdBody string func InitGadgetsRegisterCmd() { - GadgetsRegisterCmd.Flags().StringVar(&GadgetsRegisterCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsRegisterCmd.Flags().StringVar(&GadgetsRegisterCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsRegisterCmd.Flags().StringVar(&GadgetsRegisterCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsRegisterCmd.Flags().StringVar(&GadgetsRegisterCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsRegisterCmd.Flags().StringVar(&GadgetsRegisterCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/gadgets_terminate.go b/soracom/generated/cmd/gadgets_terminate.go index 2a1dd810..d53fc53f 100644 --- a/soracom/generated/cmd/gadgets_terminate.go +++ b/soracom/generated/cmd/gadgets_terminate.go @@ -16,9 +16,9 @@ var GadgetsTerminateCmdProductId string var GadgetsTerminateCmdSerialNumber string func InitGadgetsTerminateCmd() { - GadgetsTerminateCmd.Flags().StringVar(&GadgetsTerminateCmdProductId, "product-id", "", TRAPI("Product ID of the target gadget.")) + GadgetsTerminateCmd.Flags().StringVar(&GadgetsTerminateCmdProductId, "product-id", "", TRAPI("Product ID of the target Gadget API compatible device.- 'button': Soracom LTE-M Button powered by AWS.- 'wimax': Soracom Cloud Camera Services Cellular Pack.")) - GadgetsTerminateCmd.Flags().StringVar(&GadgetsTerminateCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target gadget.")) + GadgetsTerminateCmd.Flags().StringVar(&GadgetsTerminateCmdSerialNumber, "serial-number", "", TRAPI("Serial Number of the target Gadget API compatible device.")) GadgetsTerminateCmd.RunE = GadgetsTerminateCmdRunE diff --git a/soracom/generated/cmd/groups_delete.go b/soracom/generated/cmd/groups_delete.go index de57af9f..ac8a760f 100644 --- a/soracom/generated/cmd/groups_delete.go +++ b/soracom/generated/cmd/groups_delete.go @@ -13,7 +13,7 @@ import ( var GroupsDeleteCmdGroupId string func InitGroupsDeleteCmd() { - GroupsDeleteCmd.Flags().StringVar(&GroupsDeleteCmdGroupId, "group-id", "", TRAPI("Target group ID.")) + GroupsDeleteCmd.Flags().StringVar(&GroupsDeleteCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsDeleteCmd.RunE = GroupsDeleteCmdRunE diff --git a/soracom/generated/cmd/groups_delete_config.go b/soracom/generated/cmd/groups_delete_config.go index 7253bfb6..c1ede499 100644 --- a/soracom/generated/cmd/groups_delete_config.go +++ b/soracom/generated/cmd/groups_delete_config.go @@ -19,7 +19,7 @@ var GroupsDeleteConfigCmdName string var GroupsDeleteConfigCmdNamespace string func InitGroupsDeleteConfigCmd() { - GroupsDeleteConfigCmd.Flags().StringVar(&GroupsDeleteConfigCmdGroupId, "group-id", "", TRAPI("Target group.")) + GroupsDeleteConfigCmd.Flags().StringVar(&GroupsDeleteConfigCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsDeleteConfigCmd.Flags().StringVar(&GroupsDeleteConfigCmdName, "name", "", TRAPI("Parameter name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) diff --git a/soracom/generated/cmd/groups_delete_config_namespace.go b/soracom/generated/cmd/groups_delete_config_namespace.go index 7cfef614..34a0d7ea 100644 --- a/soracom/generated/cmd/groups_delete_config_namespace.go +++ b/soracom/generated/cmd/groups_delete_config_namespace.go @@ -16,7 +16,7 @@ var GroupsDeleteConfigNamespaceCmdGroupId string var GroupsDeleteConfigNamespaceCmdNamespace string func InitGroupsDeleteConfigNamespaceCmd() { - GroupsDeleteConfigNamespaceCmd.Flags().StringVar(&GroupsDeleteConfigNamespaceCmdGroupId, "group-id", "", TRAPI("Target group.")) + GroupsDeleteConfigNamespaceCmd.Flags().StringVar(&GroupsDeleteConfigNamespaceCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsDeleteConfigNamespaceCmd.Flags().StringVar(&GroupsDeleteConfigNamespaceCmdNamespace, "namespace", "", TRAPI("Namespace to be deleted.")) diff --git a/soracom/generated/cmd/groups_delete_tag.go b/soracom/generated/cmd/groups_delete_tag.go index d74fe6ba..ca5ffaf0 100644 --- a/soracom/generated/cmd/groups_delete_tag.go +++ b/soracom/generated/cmd/groups_delete_tag.go @@ -16,7 +16,7 @@ var GroupsDeleteTagCmdGroupId string var GroupsDeleteTagCmdTagName string func InitGroupsDeleteTagCmd() { - GroupsDeleteTagCmd.Flags().StringVar(&GroupsDeleteTagCmdGroupId, "group-id", "", TRAPI("Target group ID.")) + GroupsDeleteTagCmd.Flags().StringVar(&GroupsDeleteTagCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsDeleteTagCmd.Flags().StringVar(&GroupsDeleteTagCmdTagName, "tag-name", "", TRAPI("Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) diff --git a/soracom/generated/cmd/groups_get.go b/soracom/generated/cmd/groups_get.go index b43fa35e..0e42f606 100644 --- a/soracom/generated/cmd/groups_get.go +++ b/soracom/generated/cmd/groups_get.go @@ -13,7 +13,7 @@ import ( var GroupsGetCmdGroupId string func InitGroupsGetCmd() { - GroupsGetCmd.Flags().StringVar(&GroupsGetCmdGroupId, "group-id", "", TRAPI("Target group ID.")) + GroupsGetCmd.Flags().StringVar(&GroupsGetCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsGetCmd.RunE = GroupsGetCmdRunE diff --git a/soracom/generated/cmd/groups_list.go b/soracom/generated/cmd/groups_list.go index ebe6f558..0904e444 100644 --- a/soracom/generated/cmd/groups_list.go +++ b/soracom/generated/cmd/groups_list.go @@ -37,7 +37,7 @@ func InitGroupsListCmd() { GroupsListCmd.Flags().StringVar(&GroupsListCmdTagValue, "tag-value", "", TRAPI("Tag value of the groups.")) - GroupsListCmd.Flags().StringVar(&GroupsListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Tag match mode.")) + GroupsListCmd.Flags().StringVar(&GroupsListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Search criteria for tag strings ('tag_value').")) GroupsListCmd.Flags().Int64Var(&GroupsListCmdLimit, "limit", 0, TRAPI("Maximum number of results per response page.")) diff --git a/soracom/generated/cmd/groups_list_subscribers.go b/soracom/generated/cmd/groups_list_subscribers.go index 1b17c8ff..98552426 100644 --- a/soracom/generated/cmd/groups_list_subscribers.go +++ b/soracom/generated/cmd/groups_list_subscribers.go @@ -21,8 +21,11 @@ var GroupsListSubscribersCmdLimit int64 // GroupsListSubscribersCmdPaginate indicates to do pagination or not var GroupsListSubscribersCmdPaginate bool +// GroupsListSubscribersCmdOutputJSONL indicates to output with jsonl format +var GroupsListSubscribersCmdOutputJSONL bool + func InitGroupsListSubscribersCmd() { - GroupsListSubscribersCmd.Flags().StringVar(&GroupsListSubscribersCmdGroupId, "group-id", "", TRAPI("Target group ID.")) + GroupsListSubscribersCmd.Flags().StringVar(&GroupsListSubscribersCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsListSubscribersCmd.Flags().StringVar(&GroupsListSubscribersCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward.")) @@ -30,6 +33,8 @@ func InitGroupsListSubscribersCmd() { GroupsListSubscribersCmd.Flags().BoolVar(&GroupsListSubscribersCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) + GroupsListSubscribersCmd.Flags().BoolVar(&GroupsListSubscribersCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) + GroupsListSubscribersCmd.RunE = GroupsListSubscribersCmdRunE GroupsCmd.AddCommand(GroupsListSubscribersCmd) @@ -81,6 +86,10 @@ func GroupsListSubscribersCmdRunE(cmd *cobra.Command, args []string) error { if rawOutput { _, err = os.Stdout.Write([]byte(body)) } else { + if GroupsListSubscribersCmdOutputJSONL { + return printStringAsJSONL(body) + } + return prettyPrintStringAsJSON(body) } return err diff --git a/soracom/generated/cmd/groups_put_config.go b/soracom/generated/cmd/groups_put_config.go index 4ca303ec..9426eb0f 100644 --- a/soracom/generated/cmd/groups_put_config.go +++ b/soracom/generated/cmd/groups_put_config.go @@ -23,7 +23,7 @@ var GroupsPutConfigCmdNamespace string var GroupsPutConfigCmdBody string func InitGroupsPutConfigCmd() { - GroupsPutConfigCmd.Flags().StringVar(&GroupsPutConfigCmdGroupId, "group-id", "", TRAPI("Target group.")) + GroupsPutConfigCmd.Flags().StringVar(&GroupsPutConfigCmdGroupId, "group-id", "", TRAPI("ID of the target Group. It can be obtained via ['Group:listGroups API'](#/Group/listGroups).")) GroupsPutConfigCmd.Flags().StringVar(&GroupsPutConfigCmdNamespace, "namespace", "", TRAPI("Target configuration.")) diff --git a/soracom/generated/cmd/groups_put_tags.go b/soracom/generated/cmd/groups_put_tags.go index 9f86b753..6a098505 100644 --- a/soracom/generated/cmd/groups_put_tags.go +++ b/soracom/generated/cmd/groups_put_tags.go @@ -20,7 +20,7 @@ var GroupsPutTagsCmdGroupId string var GroupsPutTagsCmdBody string func InitGroupsPutTagsCmd() { - GroupsPutTagsCmd.Flags().StringVar(&GroupsPutTagsCmdGroupId, "group-id", "", TRAPI("Target group ID.")) + GroupsPutTagsCmd.Flags().StringVar(&GroupsPutTagsCmdGroupId, "group-id", "", TRAPI("ID of the target Group.")) GroupsPutTagsCmd.Flags().StringVar(&GroupsPutTagsCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_dashboards_init_permissions.go b/soracom/generated/cmd/lagoon_dashboards_init_permissions.go index 94bac432..21bfcc79 100644 --- a/soracom/generated/cmd/lagoon_dashboards_init_permissions.go +++ b/soracom/generated/cmd/lagoon_dashboards_init_permissions.go @@ -16,9 +16,9 @@ var LagoonDashboardsInitPermissionsCmdDashboardId int64 var LagoonDashboardsInitPermissionsCmdV2 bool func InitLagoonDashboardsInitPermissionsCmd() { - LagoonDashboardsInitPermissionsCmd.Flags().Int64Var(&LagoonDashboardsInitPermissionsCmdDashboardId, "dashboard-id", 0, TRAPI("dashboard_id")) + LagoonDashboardsInitPermissionsCmd.Flags().Int64Var(&LagoonDashboardsInitPermissionsCmdDashboardId, "dashboard-id", 0, TRAPI("ID of the target Dashboard.")) - LagoonDashboardsInitPermissionsCmd.Flags().BoolVar(&LagoonDashboardsInitPermissionsCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2. This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) + LagoonDashboardsInitPermissionsCmd.Flags().BoolVar(&LagoonDashboardsInitPermissionsCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) LagoonDashboardsInitPermissionsCmd.RunE = LagoonDashboardsInitPermissionsCmdRunE diff --git a/soracom/generated/cmd/lagoon_dashboards_list_permissions.go b/soracom/generated/cmd/lagoon_dashboards_list_permissions.go index 524bafc1..abb9a69f 100644 --- a/soracom/generated/cmd/lagoon_dashboards_list_permissions.go +++ b/soracom/generated/cmd/lagoon_dashboards_list_permissions.go @@ -16,7 +16,7 @@ var LagoonDashboardsListPermissionsCmdV2 bool var LagoonDashboardsListPermissionsCmdOutputJSONL bool func InitLagoonDashboardsListPermissionsCmd() { - LagoonDashboardsListPermissionsCmd.Flags().BoolVar(&LagoonDashboardsListPermissionsCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2. This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) + LagoonDashboardsListPermissionsCmd.Flags().BoolVar(&LagoonDashboardsListPermissionsCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) LagoonDashboardsListPermissionsCmd.Flags().BoolVar(&LagoonDashboardsListPermissionsCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/lagoon_dashboards_update_permissions.go b/soracom/generated/cmd/lagoon_dashboards_update_permissions.go index 3635a7ba..839ed9f9 100644 --- a/soracom/generated/cmd/lagoon_dashboards_update_permissions.go +++ b/soracom/generated/cmd/lagoon_dashboards_update_permissions.go @@ -23,7 +23,7 @@ var LagoonDashboardsUpdatePermissionsCmdV2 bool var LagoonDashboardsUpdatePermissionsCmdBody string func InitLagoonDashboardsUpdatePermissionsCmd() { - LagoonDashboardsUpdatePermissionsCmd.Flags().Int64Var(&LagoonDashboardsUpdatePermissionsCmdDashboardId, "dashboard-id", 0, TRAPI("dashboard_id")) + LagoonDashboardsUpdatePermissionsCmd.Flags().Int64Var(&LagoonDashboardsUpdatePermissionsCmdDashboardId, "dashboard-id", 0, TRAPI("ID of the target Dashboard.")) LagoonDashboardsUpdatePermissionsCmd.Flags().BoolVar(&LagoonDashboardsUpdatePermissionsCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) diff --git a/soracom/generated/cmd/lagoon_delete_user.go b/soracom/generated/cmd/lagoon_delete_user.go index 0ec2d924..c8270911 100644 --- a/soracom/generated/cmd/lagoon_delete_user.go +++ b/soracom/generated/cmd/lagoon_delete_user.go @@ -13,7 +13,7 @@ import ( var LagoonDeleteUserCmdLagoonUserId int64 func InitLagoonDeleteUserCmd() { - LagoonDeleteUserCmd.Flags().Int64Var(&LagoonDeleteUserCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonDeleteUserCmd.Flags().Int64Var(&LagoonDeleteUserCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonDeleteUserCmd.RunE = LagoonDeleteUserCmdRunE diff --git a/soracom/generated/cmd/lagoon_get_image_link.go b/soracom/generated/cmd/lagoon_get_image_link.go index 4a52e74a..ed3ab594 100644 --- a/soracom/generated/cmd/lagoon_get_image_link.go +++ b/soracom/generated/cmd/lagoon_get_image_link.go @@ -13,7 +13,7 @@ import ( var LagoonGetImageLinkCmdV2 bool func InitLagoonGetImageLinkCmd() { - LagoonGetImageLinkCmd.Flags().BoolVar(&LagoonGetImageLinkCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2. This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) + LagoonGetImageLinkCmd.Flags().BoolVar(&LagoonGetImageLinkCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) LagoonGetImageLinkCmd.RunE = LagoonGetImageLinkCmdRunE diff --git a/soracom/generated/cmd/lagoon_list_users.go b/soracom/generated/cmd/lagoon_list_users.go index e4a37b84..46d7df93 100644 --- a/soracom/generated/cmd/lagoon_list_users.go +++ b/soracom/generated/cmd/lagoon_list_users.go @@ -16,7 +16,7 @@ var LagoonListUsersCmdV2 bool var LagoonListUsersCmdOutputJSONL bool func InitLagoonListUsersCmd() { - LagoonListUsersCmd.Flags().BoolVar(&LagoonListUsersCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2. This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) + LagoonListUsersCmd.Flags().BoolVar(&LagoonListUsersCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) LagoonListUsersCmd.Flags().BoolVar(&LagoonListUsersCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/lagoon_migration_migrate.go b/soracom/generated/cmd/lagoon_migration_migrate.go index 1ac29780..64c32123 100644 --- a/soracom/generated/cmd/lagoon_migration_migrate.go +++ b/soracom/generated/cmd/lagoon_migration_migrate.go @@ -20,7 +20,7 @@ var LagoonMigrationMigrateCmdDashboardIds []string var LagoonMigrationMigrateCmdBody string func InitLagoonMigrationMigrateCmd() { - LagoonMigrationMigrateCmd.Flags().StringSliceVar(&LagoonMigrationMigrateCmdDashboardIds, "dashboard-ids", []string{}, TRAPI("A list of dashboard IDs to migrate")) + LagoonMigrationMigrateCmd.Flags().StringSliceVar(&LagoonMigrationMigrateCmdDashboardIds, "dashboard-ids", []string{}, TRAPI("A list of dashboard IDs to migrate.")) LagoonMigrationMigrateCmd.Flags().StringVar(&LagoonMigrationMigrateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_update_user_email.go b/soracom/generated/cmd/lagoon_update_user_email.go index 92759260..652c4298 100644 --- a/soracom/generated/cmd/lagoon_update_user_email.go +++ b/soracom/generated/cmd/lagoon_update_user_email.go @@ -25,7 +25,7 @@ var LagoonUpdateUserEmailCmdBody string func InitLagoonUpdateUserEmailCmd() { LagoonUpdateUserEmailCmd.Flags().StringVar(&LagoonUpdateUserEmailCmdUserEmail, "user-email", "", TRAPI("")) - LagoonUpdateUserEmailCmd.Flags().Int64Var(&LagoonUpdateUserEmailCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUpdateUserEmailCmd.Flags().Int64Var(&LagoonUpdateUserEmailCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUpdateUserEmailCmd.Flags().StringVar(&LagoonUpdateUserEmailCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_update_user_password.go b/soracom/generated/cmd/lagoon_update_user_password.go index b03c8082..1b404365 100644 --- a/soracom/generated/cmd/lagoon_update_user_password.go +++ b/soracom/generated/cmd/lagoon_update_user_password.go @@ -30,7 +30,7 @@ func InitLagoonUpdateUserPasswordCmd() { LagoonUpdateUserPasswordCmd.Flags().StringVar(&LagoonUpdateUserPasswordCmdOldPassword, "old-password", "", TRAPI("")) - LagoonUpdateUserPasswordCmd.Flags().Int64Var(&LagoonUpdateUserPasswordCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUpdateUserPasswordCmd.Flags().Int64Var(&LagoonUpdateUserPasswordCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUpdateUserPasswordCmd.Flags().StringVar(&LagoonUpdateUserPasswordCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_update_user_permission.go b/soracom/generated/cmd/lagoon_update_user_permission.go index 50f8ca0d..4db55937 100644 --- a/soracom/generated/cmd/lagoon_update_user_permission.go +++ b/soracom/generated/cmd/lagoon_update_user_permission.go @@ -25,7 +25,7 @@ var LagoonUpdateUserPermissionCmdBody string func InitLagoonUpdateUserPermissionCmd() { LagoonUpdateUserPermissionCmd.Flags().StringVar(&LagoonUpdateUserPermissionCmdRole, "role", "", TRAPI("A role that represents the permission.")) - LagoonUpdateUserPermissionCmd.Flags().Int64Var(&LagoonUpdateUserPermissionCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUpdateUserPermissionCmd.Flags().Int64Var(&LagoonUpdateUserPermissionCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUpdateUserPermissionCmd.Flags().StringVar(&LagoonUpdateUserPermissionCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_users_delete.go b/soracom/generated/cmd/lagoon_users_delete.go index 626c6524..54bc9c95 100644 --- a/soracom/generated/cmd/lagoon_users_delete.go +++ b/soracom/generated/cmd/lagoon_users_delete.go @@ -13,7 +13,7 @@ import ( var LagoonUsersDeleteCmdLagoonUserId int64 func InitLagoonUsersDeleteCmd() { - LagoonUsersDeleteCmd.Flags().Int64Var(&LagoonUsersDeleteCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUsersDeleteCmd.Flags().Int64Var(&LagoonUsersDeleteCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUsersDeleteCmd.RunE = LagoonUsersDeleteCmdRunE diff --git a/soracom/generated/cmd/lagoon_users_list.go b/soracom/generated/cmd/lagoon_users_list.go index b447dc8f..3ea3bf0c 100644 --- a/soracom/generated/cmd/lagoon_users_list.go +++ b/soracom/generated/cmd/lagoon_users_list.go @@ -16,7 +16,7 @@ var LagoonUsersListCmdV2 bool var LagoonUsersListCmdOutputJSONL bool func InitLagoonUsersListCmd() { - LagoonUsersListCmd.Flags().BoolVar(&LagoonUsersListCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2. This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) + LagoonUsersListCmd.Flags().BoolVar(&LagoonUsersListCmdV2, "v2", false, TRAPI("If the value is true, a request will be issued to Lagoon 2.This is only valid if both Lagoon 3 and Lagoon 2 are enabled.")) LagoonUsersListCmd.Flags().BoolVar(&LagoonUsersListCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/lagoon_users_update_email.go b/soracom/generated/cmd/lagoon_users_update_email.go index e318b68e..24206c3a 100644 --- a/soracom/generated/cmd/lagoon_users_update_email.go +++ b/soracom/generated/cmd/lagoon_users_update_email.go @@ -25,7 +25,7 @@ var LagoonUsersUpdateEmailCmdBody string func InitLagoonUsersUpdateEmailCmd() { LagoonUsersUpdateEmailCmd.Flags().StringVar(&LagoonUsersUpdateEmailCmdUserEmail, "user-email", "", TRAPI("")) - LagoonUsersUpdateEmailCmd.Flags().Int64Var(&LagoonUsersUpdateEmailCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUsersUpdateEmailCmd.Flags().Int64Var(&LagoonUsersUpdateEmailCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUsersUpdateEmailCmd.Flags().StringVar(&LagoonUsersUpdateEmailCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_users_update_password.go b/soracom/generated/cmd/lagoon_users_update_password.go index 8d8950d0..8c9f667e 100644 --- a/soracom/generated/cmd/lagoon_users_update_password.go +++ b/soracom/generated/cmd/lagoon_users_update_password.go @@ -30,7 +30,7 @@ func InitLagoonUsersUpdatePasswordCmd() { LagoonUsersUpdatePasswordCmd.Flags().StringVar(&LagoonUsersUpdatePasswordCmdOldPassword, "old-password", "", TRAPI("")) - LagoonUsersUpdatePasswordCmd.Flags().Int64Var(&LagoonUsersUpdatePasswordCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUsersUpdatePasswordCmd.Flags().Int64Var(&LagoonUsersUpdatePasswordCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUsersUpdatePasswordCmd.Flags().StringVar(&LagoonUsersUpdatePasswordCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lagoon_users_update_permission.go b/soracom/generated/cmd/lagoon_users_update_permission.go index fb75de98..dfb99084 100644 --- a/soracom/generated/cmd/lagoon_users_update_permission.go +++ b/soracom/generated/cmd/lagoon_users_update_permission.go @@ -25,7 +25,7 @@ var LagoonUsersUpdatePermissionCmdBody string func InitLagoonUsersUpdatePermissionCmd() { LagoonUsersUpdatePermissionCmd.Flags().StringVar(&LagoonUsersUpdatePermissionCmdRole, "role", "", TRAPI("A role that represents the permission.")) - LagoonUsersUpdatePermissionCmd.Flags().Int64Var(&LagoonUsersUpdatePermissionCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user")) + LagoonUsersUpdatePermissionCmd.Flags().Int64Var(&LagoonUsersUpdatePermissionCmdLagoonUserId, "lagoon-user-id", 0, TRAPI("Target ID of the lagoon user.")) LagoonUsersUpdatePermissionCmd.Flags().StringVar(&LagoonUsersUpdatePermissionCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/logs_get.go b/soracom/generated/cmd/logs_get.go index 74f529a2..14701112 100644 --- a/soracom/generated/cmd/logs_get.go +++ b/soracom/generated/cmd/logs_get.go @@ -45,11 +45,11 @@ func InitLogsGetCmd() { LogsGetCmd.Flags().StringVar(&LogsGetCmdService, "service", "", TRAPI("Service name to filter log entries.")) - LogsGetCmd.Flags().Int64Var(&LogsGetCmdFrom, "from", 0, TRAPI("Start time for the log search range (unixtime).")) + LogsGetCmd.Flags().Int64Var(&LogsGetCmdFrom, "from", 0, TRAPI("Start time for the log search range (UNIX time in milliseconds).")) LogsGetCmd.Flags().Int64Var(&LogsGetCmdLimit, "limit", 0, TRAPI("Maximum number of log entries to retrieve.")) - LogsGetCmd.Flags().Int64Var(&LogsGetCmdTo, "to", 0, TRAPI("End time for the log search range (unixtime).")) + LogsGetCmd.Flags().Int64Var(&LogsGetCmdTo, "to", 0, TRAPI("End time for the log search range (UNIX time in milliseconds).")) LogsGetCmd.Flags().BoolVar(&LogsGetCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/lora_devices_get_data.go b/soracom/generated/cmd/lora_devices_get_data.go index 79e00038..acb9ff94 100644 --- a/soracom/generated/cmd/lora_devices_get_data.go +++ b/soracom/generated/cmd/lora_devices_get_data.go @@ -42,7 +42,7 @@ func InitLoraDevicesGetDataCmd() { LoraDevicesGetDataCmd.Flags().Int64Var(&LoraDevicesGetDataCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - LoraDevicesGetDataCmd.Flags().Int64Var(&LoraDevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve.")) + LoraDevicesGetDataCmd.Flags().Int64Var(&LoraDevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) LoraDevicesGetDataCmd.Flags().Int64Var(&LoraDevicesGetDataCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/lora_gateways_delete_tag.go b/soracom/generated/cmd/lora_gateways_delete_tag.go index 57bb58d9..d92fab6a 100644 --- a/soracom/generated/cmd/lora_gateways_delete_tag.go +++ b/soracom/generated/cmd/lora_gateways_delete_tag.go @@ -16,9 +16,9 @@ var LoraGatewaysDeleteTagCmdGatewayId string var LoraGatewaysDeleteTagCmdTagName string func InitLoraGatewaysDeleteTagCmd() { - LoraGatewaysDeleteTagCmd.Flags().StringVar(&LoraGatewaysDeleteTagCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysDeleteTagCmd.Flags().StringVar(&LoraGatewaysDeleteTagCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) - LoraGatewaysDeleteTagCmd.Flags().StringVar(&LoraGatewaysDeleteTagCmdTagName, "tag-name", "", TRAPI("Name of tag to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) + LoraGatewaysDeleteTagCmd.Flags().StringVar(&LoraGatewaysDeleteTagCmdTagName, "tag-name", "", TRAPI("Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) LoraGatewaysDeleteTagCmd.RunE = LoraGatewaysDeleteTagCmdRunE diff --git a/soracom/generated/cmd/lora_gateways_disable_termination.go b/soracom/generated/cmd/lora_gateways_disable_termination.go index 5c8ce9e7..e1cd4779 100644 --- a/soracom/generated/cmd/lora_gateways_disable_termination.go +++ b/soracom/generated/cmd/lora_gateways_disable_termination.go @@ -13,7 +13,7 @@ import ( var LoraGatewaysDisableTerminationCmdGatewayId string func InitLoraGatewaysDisableTerminationCmd() { - LoraGatewaysDisableTerminationCmd.Flags().StringVar(&LoraGatewaysDisableTerminationCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysDisableTerminationCmd.Flags().StringVar(&LoraGatewaysDisableTerminationCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysDisableTerminationCmd.RunE = LoraGatewaysDisableTerminationCmdRunE diff --git a/soracom/generated/cmd/lora_gateways_enable_termination.go b/soracom/generated/cmd/lora_gateways_enable_termination.go index 9f2a4293..f4ac1ee5 100644 --- a/soracom/generated/cmd/lora_gateways_enable_termination.go +++ b/soracom/generated/cmd/lora_gateways_enable_termination.go @@ -13,7 +13,7 @@ import ( var LoraGatewaysEnableTerminationCmdGatewayId string func InitLoraGatewaysEnableTerminationCmd() { - LoraGatewaysEnableTerminationCmd.Flags().StringVar(&LoraGatewaysEnableTerminationCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysEnableTerminationCmd.Flags().StringVar(&LoraGatewaysEnableTerminationCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysEnableTerminationCmd.RunE = LoraGatewaysEnableTerminationCmdRunE diff --git a/soracom/generated/cmd/lora_gateways_get.go b/soracom/generated/cmd/lora_gateways_get.go index f4137b9b..dc091416 100644 --- a/soracom/generated/cmd/lora_gateways_get.go +++ b/soracom/generated/cmd/lora_gateways_get.go @@ -13,7 +13,7 @@ import ( var LoraGatewaysGetCmdGatewayId string func InitLoraGatewaysGetCmd() { - LoraGatewaysGetCmd.Flags().StringVar(&LoraGatewaysGetCmdGatewayId, "gateway-id", "", TRAPI("Gateway ID of the target LoRa gateway.")) + LoraGatewaysGetCmd.Flags().StringVar(&LoraGatewaysGetCmdGatewayId, "gateway-id", "", TRAPI("Gateway ID of the target LoRaWAN gateway.")) LoraGatewaysGetCmd.RunE = LoraGatewaysGetCmdRunE diff --git a/soracom/generated/cmd/lora_gateways_list.go b/soracom/generated/cmd/lora_gateways_list.go index 56f7eeff..4081a65f 100644 --- a/soracom/generated/cmd/lora_gateways_list.go +++ b/soracom/generated/cmd/lora_gateways_list.go @@ -31,7 +31,7 @@ var LoraGatewaysListCmdPaginate bool var LoraGatewaysListCmdOutputJSONL bool func InitLoraGatewaysListCmd() { - LoraGatewaysListCmd.Flags().StringVar(&LoraGatewaysListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The device ID of the last device retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device onward.")) + LoraGatewaysListCmd.Flags().StringVar(&LoraGatewaysListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.")) LoraGatewaysListCmd.Flags().StringVar(&LoraGatewaysListCmdTagName, "tag-name", "", TRAPI("Tag name for filtering the search (exact match).")) @@ -39,7 +39,7 @@ func InitLoraGatewaysListCmd() { LoraGatewaysListCmd.Flags().StringVar(&LoraGatewaysListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Tag match mode.")) - LoraGatewaysListCmd.Flags().Int64Var(&LoraGatewaysListCmdLimit, "limit", 0, TRAPI("Maximum number of LoRa devices to retrieve.")) + LoraGatewaysListCmd.Flags().Int64Var(&LoraGatewaysListCmdLimit, "limit", 0, TRAPI("Maximum number of LoRaWAN gateways to retrieve.")) LoraGatewaysListCmd.Flags().BoolVar(&LoraGatewaysListCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/lora_gateways_put_tags.go b/soracom/generated/cmd/lora_gateways_put_tags.go index a36948f4..0ff44439 100644 --- a/soracom/generated/cmd/lora_gateways_put_tags.go +++ b/soracom/generated/cmd/lora_gateways_put_tags.go @@ -20,7 +20,7 @@ var LoraGatewaysPutTagsCmdGatewayId string var LoraGatewaysPutTagsCmdBody string func InitLoraGatewaysPutTagsCmd() { - LoraGatewaysPutTagsCmd.Flags().StringVar(&LoraGatewaysPutTagsCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysPutTagsCmd.Flags().StringVar(&LoraGatewaysPutTagsCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysPutTagsCmd.Flags().StringVar(&LoraGatewaysPutTagsCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lora_gateways_set_network_set.go b/soracom/generated/cmd/lora_gateways_set_network_set.go index 3c6ef32c..21829ff2 100644 --- a/soracom/generated/cmd/lora_gateways_set_network_set.go +++ b/soracom/generated/cmd/lora_gateways_set_network_set.go @@ -23,7 +23,7 @@ var LoraGatewaysSetNetworkSetCmdNetworkSetId string var LoraGatewaysSetNetworkSetCmdBody string func InitLoraGatewaysSetNetworkSetCmd() { - LoraGatewaysSetNetworkSetCmd.Flags().StringVar(&LoraGatewaysSetNetworkSetCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysSetNetworkSetCmd.Flags().StringVar(&LoraGatewaysSetNetworkSetCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysSetNetworkSetCmd.Flags().StringVar(&LoraGatewaysSetNetworkSetCmdNetworkSetId, "network-set-id", "", TRAPI("")) diff --git a/soracom/generated/cmd/lora_gateways_terminate.go b/soracom/generated/cmd/lora_gateways_terminate.go index 7935d7cc..9955f5f9 100644 --- a/soracom/generated/cmd/lora_gateways_terminate.go +++ b/soracom/generated/cmd/lora_gateways_terminate.go @@ -13,7 +13,7 @@ import ( var LoraGatewaysTerminateCmdGatewayId string func InitLoraGatewaysTerminateCmd() { - LoraGatewaysTerminateCmd.Flags().StringVar(&LoraGatewaysTerminateCmdGatewayId, "gateway-id", "", TRAPI("Device ID of the target LoRa gateway.")) + LoraGatewaysTerminateCmd.Flags().StringVar(&LoraGatewaysTerminateCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysTerminateCmd.RunE = LoraGatewaysTerminateCmdRunE diff --git a/soracom/generated/cmd/lora_gateways_unset_network_set.go b/soracom/generated/cmd/lora_gateways_unset_network_set.go index da1883e3..420ec624 100644 --- a/soracom/generated/cmd/lora_gateways_unset_network_set.go +++ b/soracom/generated/cmd/lora_gateways_unset_network_set.go @@ -13,7 +13,7 @@ import ( var LoraGatewaysUnsetNetworkSetCmdGatewayId string func InitLoraGatewaysUnsetNetworkSetCmd() { - LoraGatewaysUnsetNetworkSetCmd.Flags().StringVar(&LoraGatewaysUnsetNetworkSetCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRa gateway.")) + LoraGatewaysUnsetNetworkSetCmd.Flags().StringVar(&LoraGatewaysUnsetNetworkSetCmdGatewayId, "gateway-id", "", TRAPI("ID of the target LoRaWAN gateway.")) LoraGatewaysUnsetNetworkSetCmd.RunE = LoraGatewaysUnsetNetworkSetCmdRunE diff --git a/soracom/generated/cmd/lora_network_sets_add_permission.go b/soracom/generated/cmd/lora_network_sets_add_permission.go index 90f5c932..cb5e6a0b 100644 --- a/soracom/generated/cmd/lora_network_sets_add_permission.go +++ b/soracom/generated/cmd/lora_network_sets_add_permission.go @@ -23,7 +23,7 @@ var LoraNetworkSetsAddPermissionCmdOperatorId string var LoraNetworkSetsAddPermissionCmdBody string func InitLoraNetworkSetsAddPermissionCmd() { - LoraNetworkSetsAddPermissionCmd.Flags().StringVar(&LoraNetworkSetsAddPermissionCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsAddPermissionCmd.Flags().StringVar(&LoraNetworkSetsAddPermissionCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) LoraNetworkSetsAddPermissionCmd.Flags().StringVar(&LoraNetworkSetsAddPermissionCmdOperatorId, "operator-id", "", TRAPI("")) diff --git a/soracom/generated/cmd/lora_network_sets_delete.go b/soracom/generated/cmd/lora_network_sets_delete.go index 734f1814..0341b127 100644 --- a/soracom/generated/cmd/lora_network_sets_delete.go +++ b/soracom/generated/cmd/lora_network_sets_delete.go @@ -13,7 +13,7 @@ import ( var LoraNetworkSetsDeleteCmdNsId string func InitLoraNetworkSetsDeleteCmd() { - LoraNetworkSetsDeleteCmd.Flags().StringVar(&LoraNetworkSetsDeleteCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsDeleteCmd.Flags().StringVar(&LoraNetworkSetsDeleteCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) LoraNetworkSetsDeleteCmd.RunE = LoraNetworkSetsDeleteCmdRunE diff --git a/soracom/generated/cmd/lora_network_sets_delete_tag.go b/soracom/generated/cmd/lora_network_sets_delete_tag.go index 0f618fd6..05189583 100644 --- a/soracom/generated/cmd/lora_network_sets_delete_tag.go +++ b/soracom/generated/cmd/lora_network_sets_delete_tag.go @@ -16,9 +16,9 @@ var LoraNetworkSetsDeleteTagCmdNsId string var LoraNetworkSetsDeleteTagCmdTagName string func InitLoraNetworkSetsDeleteTagCmd() { - LoraNetworkSetsDeleteTagCmd.Flags().StringVar(&LoraNetworkSetsDeleteTagCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsDeleteTagCmd.Flags().StringVar(&LoraNetworkSetsDeleteTagCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) - LoraNetworkSetsDeleteTagCmd.Flags().StringVar(&LoraNetworkSetsDeleteTagCmdTagName, "tag-name", "", TRAPI("Name of tag to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) + LoraNetworkSetsDeleteTagCmd.Flags().StringVar(&LoraNetworkSetsDeleteTagCmdTagName, "tag-name", "", TRAPI("Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)")) LoraNetworkSetsDeleteTagCmd.RunE = LoraNetworkSetsDeleteTagCmdRunE diff --git a/soracom/generated/cmd/lora_network_sets_get.go b/soracom/generated/cmd/lora_network_sets_get.go index c632edab..6abbc29a 100644 --- a/soracom/generated/cmd/lora_network_sets_get.go +++ b/soracom/generated/cmd/lora_network_sets_get.go @@ -13,7 +13,7 @@ import ( var LoraNetworkSetsGetCmdNsId string func InitLoraNetworkSetsGetCmd() { - LoraNetworkSetsGetCmd.Flags().StringVar(&LoraNetworkSetsGetCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsGetCmd.Flags().StringVar(&LoraNetworkSetsGetCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) LoraNetworkSetsGetCmd.RunE = LoraNetworkSetsGetCmdRunE diff --git a/soracom/generated/cmd/lora_network_sets_list.go b/soracom/generated/cmd/lora_network_sets_list.go index 4b0bf021..3986561e 100644 --- a/soracom/generated/cmd/lora_network_sets_list.go +++ b/soracom/generated/cmd/lora_network_sets_list.go @@ -39,7 +39,7 @@ func InitLoraNetworkSetsListCmd() { LoraNetworkSetsListCmd.Flags().StringVar(&LoraNetworkSetsListCmdTagValueMatchMode, "tag-value-match-mode", "exact", TRAPI("Tag match mode.")) - LoraNetworkSetsListCmd.Flags().Int64Var(&LoraNetworkSetsListCmdLimit, "limit", 0, TRAPI("Maximum number of LoRa devices to retrieve.")) + LoraNetworkSetsListCmd.Flags().Int64Var(&LoraNetworkSetsListCmdLimit, "limit", 0, TRAPI("Maximum number of LoRaWAN network set to retrieve.")) LoraNetworkSetsListCmd.Flags().BoolVar(&LoraNetworkSetsListCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/lora_network_sets_list_gateways.go b/soracom/generated/cmd/lora_network_sets_list_gateways.go index 2702d2af..48ac827f 100644 --- a/soracom/generated/cmd/lora_network_sets_list_gateways.go +++ b/soracom/generated/cmd/lora_network_sets_list_gateways.go @@ -25,11 +25,11 @@ var LoraNetworkSetsListGatewaysCmdPaginate bool var LoraNetworkSetsListGatewaysCmdOutputJSONL bool func InitLoraNetworkSetsListGatewaysCmd() { - LoraNetworkSetsListGatewaysCmd.Flags().StringVar(&LoraNetworkSetsListGatewaysCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The ID of the last gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device onward.")) + LoraNetworkSetsListGatewaysCmd.Flags().StringVar(&LoraNetworkSetsListGatewaysCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward.")) - LoraNetworkSetsListGatewaysCmd.Flags().StringVar(&LoraNetworkSetsListGatewaysCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsListGatewaysCmd.Flags().StringVar(&LoraNetworkSetsListGatewaysCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) - LoraNetworkSetsListGatewaysCmd.Flags().Int64Var(&LoraNetworkSetsListGatewaysCmdLimit, "limit", 0, TRAPI("Maximum number of LoRa gateways to retrieve.")) + LoraNetworkSetsListGatewaysCmd.Flags().Int64Var(&LoraNetworkSetsListGatewaysCmdLimit, "limit", 0, TRAPI("Maximum number of LoRaWAN gateways to retrieve.")) LoraNetworkSetsListGatewaysCmd.Flags().BoolVar(&LoraNetworkSetsListGatewaysCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/lora_network_sets_put_tag.go b/soracom/generated/cmd/lora_network_sets_put_tag.go index 64ef958d..4e21c28a 100644 --- a/soracom/generated/cmd/lora_network_sets_put_tag.go +++ b/soracom/generated/cmd/lora_network_sets_put_tag.go @@ -20,7 +20,7 @@ var LoraNetworkSetsPutTagCmdNsId string var LoraNetworkSetsPutTagCmdBody string func InitLoraNetworkSetsPutTagCmd() { - LoraNetworkSetsPutTagCmd.Flags().StringVar(&LoraNetworkSetsPutTagCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsPutTagCmd.Flags().StringVar(&LoraNetworkSetsPutTagCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) LoraNetworkSetsPutTagCmd.Flags().StringVar(&LoraNetworkSetsPutTagCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/lora_network_sets_revoke_permission.go b/soracom/generated/cmd/lora_network_sets_revoke_permission.go index 73d071e1..1c2ecf81 100644 --- a/soracom/generated/cmd/lora_network_sets_revoke_permission.go +++ b/soracom/generated/cmd/lora_network_sets_revoke_permission.go @@ -23,7 +23,7 @@ var LoraNetworkSetsRevokePermissionCmdOperatorId string var LoraNetworkSetsRevokePermissionCmdBody string func InitLoraNetworkSetsRevokePermissionCmd() { - LoraNetworkSetsRevokePermissionCmd.Flags().StringVar(&LoraNetworkSetsRevokePermissionCmdNsId, "ns-id", "", TRAPI("ID of the target LoRa network set.")) + LoraNetworkSetsRevokePermissionCmd.Flags().StringVar(&LoraNetworkSetsRevokePermissionCmdNsId, "ns-id", "", TRAPI("ID of the target LoRaWAN network set.")) LoraNetworkSetsRevokePermissionCmd.Flags().StringVar(&LoraNetworkSetsRevokePermissionCmdOperatorId, "operator-id", "", TRAPI("")) diff --git a/soracom/generated/cmd/operator_add_contract.go b/soracom/generated/cmd/operator_add_contract.go index 625f2d0e..e2e91ac5 100644 --- a/soracom/generated/cmd/operator_add_contract.go +++ b/soracom/generated/cmd/operator_add_contract.go @@ -25,7 +25,7 @@ var OperatorAddContractCmdBody string func InitOperatorAddContractCmd() { OperatorAddContractCmd.Flags().StringVar(&OperatorAddContractCmdContractName, "contract-name", "", TRAPI("")) - OperatorAddContractCmd.Flags().StringVar(&OperatorAddContractCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorAddContractCmd.Flags().StringVar(&OperatorAddContractCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorAddContractCmd.Flags().StringVar(&OperatorAddContractCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/operator_add_coverage_type.go b/soracom/generated/cmd/operator_add_coverage_type.go index 07a6a7af..f09213be 100644 --- a/soracom/generated/cmd/operator_add_coverage_type.go +++ b/soracom/generated/cmd/operator_add_coverage_type.go @@ -16,9 +16,9 @@ var OperatorAddCoverageTypeCmdCoverageType string var OperatorAddCoverageTypeCmdOperatorId string func InitOperatorAddCoverageTypeCmd() { - OperatorAddCoverageTypeCmd.Flags().StringVar(&OperatorAddCoverageTypeCmdCoverageType, "coverage-type", "", TRAPI("coverage_type")) + OperatorAddCoverageTypeCmd.Flags().StringVar(&OperatorAddCoverageTypeCmdCoverageType, "coverage-type", "", TRAPI("Coverage type.")) - OperatorAddCoverageTypeCmd.Flags().StringVar(&OperatorAddCoverageTypeCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorAddCoverageTypeCmd.Flags().StringVar(&OperatorAddCoverageTypeCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorAddCoverageTypeCmd.RunE = OperatorAddCoverageTypeCmdRunE diff --git a/soracom/generated/cmd/operator_auth_keys_delete.go b/soracom/generated/cmd/operator_auth_keys_delete.go index 4c58649e..bf17a6df 100644 --- a/soracom/generated/cmd/operator_auth_keys_delete.go +++ b/soracom/generated/cmd/operator_auth_keys_delete.go @@ -16,9 +16,9 @@ var OperatorAuthKeysDeleteCmdAuthKeyId string var OperatorAuthKeysDeleteCmdOperatorId string func InitOperatorAuthKeysDeleteCmd() { - OperatorAuthKeysDeleteCmd.Flags().StringVar(&OperatorAuthKeysDeleteCmdAuthKeyId, "auth-key-id", "", TRAPI("auth_key_id")) + OperatorAuthKeysDeleteCmd.Flags().StringVar(&OperatorAuthKeysDeleteCmdAuthKeyId, "auth-key-id", "", TRAPI("AuthKey ID.")) - OperatorAuthKeysDeleteCmd.Flags().StringVar(&OperatorAuthKeysDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorAuthKeysDeleteCmd.Flags().StringVar(&OperatorAuthKeysDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorAuthKeysDeleteCmd.RunE = OperatorAuthKeysDeleteCmdRunE diff --git a/soracom/generated/cmd/operator_auth_keys_generate.go b/soracom/generated/cmd/operator_auth_keys_generate.go index 668f1eef..e2080efa 100644 --- a/soracom/generated/cmd/operator_auth_keys_generate.go +++ b/soracom/generated/cmd/operator_auth_keys_generate.go @@ -13,7 +13,7 @@ import ( var OperatorAuthKeysGenerateCmdOperatorId string func InitOperatorAuthKeysGenerateCmd() { - OperatorAuthKeysGenerateCmd.Flags().StringVar(&OperatorAuthKeysGenerateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorAuthKeysGenerateCmd.Flags().StringVar(&OperatorAuthKeysGenerateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorAuthKeysGenerateCmd.RunE = OperatorAuthKeysGenerateCmdRunE diff --git a/soracom/generated/cmd/operator_auth_keys_list.go b/soracom/generated/cmd/operator_auth_keys_list.go index cfb10a5f..8410aede 100644 --- a/soracom/generated/cmd/operator_auth_keys_list.go +++ b/soracom/generated/cmd/operator_auth_keys_list.go @@ -16,7 +16,7 @@ var OperatorAuthKeysListCmdOperatorId string var OperatorAuthKeysListCmdOutputJSONL bool func InitOperatorAuthKeysListCmd() { - OperatorAuthKeysListCmd.Flags().StringVar(&OperatorAuthKeysListCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorAuthKeysListCmd.Flags().StringVar(&OperatorAuthKeysListCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorAuthKeysListCmd.Flags().BoolVar(&OperatorAuthKeysListCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/operator_configuration_delete.go b/soracom/generated/cmd/operator_configuration_delete.go index 5b041bc6..99e985c6 100644 --- a/soracom/generated/cmd/operator_configuration_delete.go +++ b/soracom/generated/cmd/operator_configuration_delete.go @@ -16,9 +16,9 @@ var OperatorConfigurationDeleteCmdNamespace string var OperatorConfigurationDeleteCmdOperatorId string func InitOperatorConfigurationDeleteCmd() { - OperatorConfigurationDeleteCmd.Flags().StringVar(&OperatorConfigurationDeleteCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration")) + OperatorConfigurationDeleteCmd.Flags().StringVar(&OperatorConfigurationDeleteCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration.")) - OperatorConfigurationDeleteCmd.Flags().StringVar(&OperatorConfigurationDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorConfigurationDeleteCmd.Flags().StringVar(&OperatorConfigurationDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorConfigurationDeleteCmd.RunE = OperatorConfigurationDeleteCmdRunE diff --git a/soracom/generated/cmd/operator_configuration_get.go b/soracom/generated/cmd/operator_configuration_get.go index 2ea21a80..925ab046 100644 --- a/soracom/generated/cmd/operator_configuration_get.go +++ b/soracom/generated/cmd/operator_configuration_get.go @@ -16,9 +16,9 @@ var OperatorConfigurationGetCmdNamespace string var OperatorConfigurationGetCmdOperatorId string func InitOperatorConfigurationGetCmd() { - OperatorConfigurationGetCmd.Flags().StringVar(&OperatorConfigurationGetCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration")) + OperatorConfigurationGetCmd.Flags().StringVar(&OperatorConfigurationGetCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration.")) - OperatorConfigurationGetCmd.Flags().StringVar(&OperatorConfigurationGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorConfigurationGetCmd.Flags().StringVar(&OperatorConfigurationGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorConfigurationGetCmd.RunE = OperatorConfigurationGetCmdRunE diff --git a/soracom/generated/cmd/operator_configuration_set.go b/soracom/generated/cmd/operator_configuration_set.go index e7011783..d9dc850d 100644 --- a/soracom/generated/cmd/operator_configuration_set.go +++ b/soracom/generated/cmd/operator_configuration_set.go @@ -26,11 +26,11 @@ var OperatorConfigurationSetCmdExpectedVersion float64 var OperatorConfigurationSetCmdBody string func InitOperatorConfigurationSetCmd() { - OperatorConfigurationSetCmd.Flags().StringVar(&OperatorConfigurationSetCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration")) + OperatorConfigurationSetCmd.Flags().StringVar(&OperatorConfigurationSetCmdNamespace, "namespace", "", TRAPI("Namespace of operator configuration.")) - OperatorConfigurationSetCmd.Flags().StringVar(&OperatorConfigurationSetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorConfigurationSetCmd.Flags().StringVar(&OperatorConfigurationSetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - OperatorConfigurationSetCmd.Flags().Float64Var(&OperatorConfigurationSetCmdExpectedVersion, "expected-version", 0, TRAPI("This property is used to avoid update confliction. To use it, retrieve the version by getOperatorConfigurationNamespace API, then specify the version here. If the expectedVersion is not specified, the API does not check an update confliction.")) + OperatorConfigurationSetCmd.Flags().Float64Var(&OperatorConfigurationSetCmdExpectedVersion, "expected-version", 0, TRAPI("This property is used to avoid update confliction. To use it, retrieve the version by getOperatorConfigurationNamespace API, then specify the version here. If the expectedVersion is not specified, the API does not check an update confliction.")) OperatorConfigurationSetCmd.Flags().StringVar(&OperatorConfigurationSetCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/operator_create.go b/soracom/generated/cmd/operator_create.go deleted file mode 100644 index 233198c9..00000000 --- a/soracom/generated/cmd/operator_create.go +++ /dev/null @@ -1,181 +0,0 @@ -// Code generated by soracom-cli generate-cmd. DO NOT EDIT. -package cmd - -import ( - "encoding/json" - "fmt" - "io" - "net/url" - "os" - - "strings" - - "github.com/spf13/cobra" -) - -// OperatorCreateCmdEmail holds value of 'email' option -var OperatorCreateCmdEmail string - -// OperatorCreateCmdPassword holds value of 'password' option -var OperatorCreateCmdPassword string - -// OperatorCreateCmdBody holds contents of request body to be sent -var OperatorCreateCmdBody string - -func InitOperatorCreateCmd() { - OperatorCreateCmd.Flags().StringVar(&OperatorCreateCmdEmail, "email", "", TRAPI("")) - - OperatorCreateCmd.Flags().StringVar(&OperatorCreateCmdPassword, "password", "", TRAPI("Requirements for password: At least 8 characters (max 100), a mixture of lowercase (a-z), uppercase (A-Z), number (0-9) letters. You can use symbols.")) - - OperatorCreateCmd.Flags().StringVar(&OperatorCreateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) - - OperatorCreateCmd.RunE = OperatorCreateCmdRunE - - OperatorCmd.AddCommand(OperatorCreateCmd) -} - -// OperatorCreateCmd defines 'create' subcommand -var OperatorCreateCmd = &cobra.Command{ - Use: "create", - Short: TRAPI("/operators:post:summary"), - Long: TRAPI(`/operators:post:description`) + "\n\n" + createLinkToAPIReference("Operator", "createOperator"), -} - -func OperatorCreateCmdRunE(cmd *cobra.Command, args []string) error { - - if len(args) > 0 { - return fmt.Errorf("unexpected arguments passed => %v", args) - } - - opt := &apiClientOptions{ - BasePath: "/v1", - Language: getSelectedLanguage(), - } - - ac := newAPIClient(opt) - if v := os.Getenv("SORACOM_VERBOSE"); v != "" { - ac.SetVerbose(true) - } - err := ac.getAPICredentials() - if err != nil { - cmd.SilenceUsage = true - return err - } - - param, err := collectOperatorCreateCmdParams(ac) - if err != nil { - return err - } - - body, err := ac.callAPI(param) - if err != nil { - cmd.SilenceUsage = true - return err - } - - if body == "" { - return nil - } - - if rawOutput { - _, err = os.Stdout.Write([]byte(body)) - } else { - return prettyPrintStringAsJSON(body) - } - return err -} - -func collectOperatorCreateCmdParams(ac *apiClient) (*apiParams, error) { - var body string - var parsedBody interface{} - var err error - body, err = buildBodyForOperatorCreateCmd() - if err != nil { - return nil, err - } - contentType := "application/json" - - if contentType == "application/json" { - err = json.Unmarshal([]byte(body), &parsedBody) - if err != nil { - return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) - } - } - - err = checkIfRequiredStringParameterIsSupplied("email", "email", "body", parsedBody, OperatorCreateCmdEmail) - if err != nil { - return nil, err - } - - err = checkIfRequiredStringParameterIsSupplied("password", "password", "body", parsedBody, OperatorCreateCmdPassword) - if err != nil { - return nil, err - } - - return &apiParams{ - method: "POST", - path: buildPathForOperatorCreateCmd("/operators"), - query: buildQueryForOperatorCreateCmd(), - contentType: contentType, - body: body, - - noRetryOnError: noRetryOnError, - }, nil -} - -func buildPathForOperatorCreateCmd(path string) string { - - return path -} - -func buildQueryForOperatorCreateCmd() url.Values { - result := url.Values{} - - return result -} - -func buildBodyForOperatorCreateCmd() (string, error) { - var result map[string]interface{} - - if OperatorCreateCmdBody != "" { - var b []byte - var err error - - if strings.HasPrefix(OperatorCreateCmdBody, "@") { - fname := strings.TrimPrefix(OperatorCreateCmdBody, "@") - // #nosec - b, err = os.ReadFile(fname) - } else if OperatorCreateCmdBody == "-" { - b, err = io.ReadAll(os.Stdin) - } else { - b = []byte(OperatorCreateCmdBody) - } - - if err != nil { - return "", err - } - - err = json.Unmarshal(b, &result) - if err != nil { - return "", err - } - } - - if result == nil { - result = make(map[string]interface{}) - } - - if OperatorCreateCmdEmail != "" { - result["email"] = OperatorCreateCmdEmail - } - - if OperatorCreateCmdPassword != "" { - result["password"] = OperatorCreateCmdPassword - } - - resultBytes, err := json.Marshal(result) - if err != nil { - return "", err - } - return string(resultBytes), nil -} diff --git a/soracom/generated/cmd/operator_create_company_information.go b/soracom/generated/cmd/operator_create_company_information.go index 3edebab6..daab72b1 100644 --- a/soracom/generated/cmd/operator_create_company_information.go +++ b/soracom/generated/cmd/operator_create_company_information.go @@ -72,7 +72,7 @@ func InitOperatorCreateCompanyInformationCmd() { OperatorCreateCompanyInformationCmd.Flags().StringVar(&OperatorCreateCompanyInformationCmdDepartment, "department", "", TRAPI("")) - OperatorCreateCompanyInformationCmd.Flags().StringVar(&OperatorCreateCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorCreateCompanyInformationCmd.Flags().StringVar(&OperatorCreateCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorCreateCompanyInformationCmd.Flags().StringVar(&OperatorCreateCompanyInformationCmdPhoneNumber, "phone-number", "", TRAPI("")) diff --git a/soracom/generated/cmd/operator_create_individual_information.go b/soracom/generated/cmd/operator_create_individual_information.go index f14e275a..19c145c6 100644 --- a/soracom/generated/cmd/operator_create_individual_information.go +++ b/soracom/generated/cmd/operator_create_individual_information.go @@ -59,7 +59,7 @@ func InitOperatorCreateIndividualInformationCmd() { OperatorCreateIndividualInformationCmd.Flags().StringVar(&OperatorCreateIndividualInformationCmdFullName, "full-name", "", TRAPI("")) - OperatorCreateIndividualInformationCmd.Flags().StringVar(&OperatorCreateIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorCreateIndividualInformationCmd.Flags().StringVar(&OperatorCreateIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorCreateIndividualInformationCmd.Flags().StringVar(&OperatorCreateIndividualInformationCmdPhoneNumber, "phone-number", "", TRAPI("")) diff --git a/soracom/generated/cmd/operator_delete_contract.go b/soracom/generated/cmd/operator_delete_contract.go index 05b51537..b77935e5 100644 --- a/soracom/generated/cmd/operator_delete_contract.go +++ b/soracom/generated/cmd/operator_delete_contract.go @@ -16,9 +16,9 @@ var OperatorDeleteContractCmdContractName string var OperatorDeleteContractCmdOperatorId string func InitOperatorDeleteContractCmd() { - OperatorDeleteContractCmd.Flags().StringVar(&OperatorDeleteContractCmdContractName, "contract-name", "", TRAPI("contract_name")) + OperatorDeleteContractCmd.Flags().StringVar(&OperatorDeleteContractCmdContractName, "contract-name", "", TRAPI("Contract name.")) - OperatorDeleteContractCmd.Flags().StringVar(&OperatorDeleteContractCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorDeleteContractCmd.Flags().StringVar(&OperatorDeleteContractCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorDeleteContractCmd.RunE = OperatorDeleteContractCmdRunE diff --git a/soracom/generated/cmd/operator_enable_mfa.go b/soracom/generated/cmd/operator_enable_mfa.go index dfc9208e..fd1a77cc 100644 --- a/soracom/generated/cmd/operator_enable_mfa.go +++ b/soracom/generated/cmd/operator_enable_mfa.go @@ -13,7 +13,7 @@ import ( var OperatorEnableMfaCmdOperatorId string func InitOperatorEnableMfaCmd() { - OperatorEnableMfaCmd.Flags().StringVar(&OperatorEnableMfaCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorEnableMfaCmd.Flags().StringVar(&OperatorEnableMfaCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorEnableMfaCmd.RunE = OperatorEnableMfaCmdRunE diff --git a/soracom/generated/cmd/operator_generate_api_token.go b/soracom/generated/cmd/operator_generate_api_token.go index dd266f2a..758aea7b 100644 --- a/soracom/generated/cmd/operator_generate_api_token.go +++ b/soracom/generated/cmd/operator_generate_api_token.go @@ -23,9 +23,9 @@ var OperatorGenerateApiTokenCmdTokenTimeoutSeconds int64 var OperatorGenerateApiTokenCmdBody string func InitOperatorGenerateApiTokenCmd() { - OperatorGenerateApiTokenCmd.Flags().StringVar(&OperatorGenerateApiTokenCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGenerateApiTokenCmd.Flags().StringVar(&OperatorGenerateApiTokenCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - OperatorGenerateApiTokenCmd.Flags().Int64Var(&OperatorGenerateApiTokenCmdTokenTimeoutSeconds, "token-timeout-seconds", 86400, TRAPI("New API token expiry duration in seconds.Default: 86400 [seconds] (24 hours)Maximum: 172800 [seconds] (48 hours)")) + OperatorGenerateApiTokenCmd.Flags().Int64Var(&OperatorGenerateApiTokenCmdTokenTimeoutSeconds, "token-timeout-seconds", 86400, TRAPI("New API token expiry duration in seconds.Default: 86400 [seconds] (24 hours).Maximum: 172800 [seconds] (48 hours).")) OperatorGenerateApiTokenCmd.Flags().StringVar(&OperatorGenerateApiTokenCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/operator_get.go b/soracom/generated/cmd/operator_get.go index 4eba150d..ea48918e 100644 --- a/soracom/generated/cmd/operator_get.go +++ b/soracom/generated/cmd/operator_get.go @@ -13,7 +13,7 @@ import ( var OperatorGetCmdOperatorId string func InitOperatorGetCmd() { - OperatorGetCmd.Flags().StringVar(&OperatorGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGetCmd.Flags().StringVar(&OperatorGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorGetCmd.RunE = OperatorGetCmdRunE diff --git a/soracom/generated/cmd/operator_get_company_information.go b/soracom/generated/cmd/operator_get_company_information.go index c1110755..5f02c105 100644 --- a/soracom/generated/cmd/operator_get_company_information.go +++ b/soracom/generated/cmd/operator_get_company_information.go @@ -13,7 +13,7 @@ import ( var OperatorGetCompanyInformationCmdOperatorId string func InitOperatorGetCompanyInformationCmd() { - OperatorGetCompanyInformationCmd.Flags().StringVar(&OperatorGetCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGetCompanyInformationCmd.Flags().StringVar(&OperatorGetCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorGetCompanyInformationCmd.RunE = OperatorGetCompanyInformationCmdRunE diff --git a/soracom/generated/cmd/operator_get_individual_information.go b/soracom/generated/cmd/operator_get_individual_information.go index 2ec398ac..a2a1bfb3 100644 --- a/soracom/generated/cmd/operator_get_individual_information.go +++ b/soracom/generated/cmd/operator_get_individual_information.go @@ -13,7 +13,7 @@ import ( var OperatorGetIndividualInformationCmdOperatorId string func InitOperatorGetIndividualInformationCmd() { - OperatorGetIndividualInformationCmd.Flags().StringVar(&OperatorGetIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGetIndividualInformationCmd.Flags().StringVar(&OperatorGetIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorGetIndividualInformationCmd.RunE = OperatorGetIndividualInformationCmdRunE diff --git a/soracom/generated/cmd/operator_get_mfa_status.go b/soracom/generated/cmd/operator_get_mfa_status.go index eea54324..e19e3f88 100644 --- a/soracom/generated/cmd/operator_get_mfa_status.go +++ b/soracom/generated/cmd/operator_get_mfa_status.go @@ -13,7 +13,7 @@ import ( var OperatorGetMfaStatusCmdOperatorId string func InitOperatorGetMfaStatusCmd() { - OperatorGetMfaStatusCmd.Flags().StringVar(&OperatorGetMfaStatusCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGetMfaStatusCmd.Flags().StringVar(&OperatorGetMfaStatusCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorGetMfaStatusCmd.RunE = OperatorGetMfaStatusCmdRunE diff --git a/soracom/generated/cmd/operator_get_support_token.go b/soracom/generated/cmd/operator_get_support_token.go index 96b5479c..eaf7c457 100644 --- a/soracom/generated/cmd/operator_get_support_token.go +++ b/soracom/generated/cmd/operator_get_support_token.go @@ -13,7 +13,7 @@ import ( var OperatorGetSupportTokenCmdOperatorId string func InitOperatorGetSupportTokenCmd() { - OperatorGetSupportTokenCmd.Flags().StringVar(&OperatorGetSupportTokenCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorGetSupportTokenCmd.Flags().StringVar(&OperatorGetSupportTokenCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorGetSupportTokenCmd.RunE = OperatorGetSupportTokenCmdRunE diff --git a/soracom/generated/cmd/operator_revoke_mfa.go b/soracom/generated/cmd/operator_revoke_mfa.go index 2ab7a551..a57216fa 100644 --- a/soracom/generated/cmd/operator_revoke_mfa.go +++ b/soracom/generated/cmd/operator_revoke_mfa.go @@ -23,9 +23,9 @@ var OperatorRevokeMfaCmdPassword string var OperatorRevokeMfaCmdBody string func InitOperatorRevokeMfaCmd() { - OperatorRevokeMfaCmd.Flags().StringVar(&OperatorRevokeMfaCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorRevokeMfaCmd.Flags().StringVar(&OperatorRevokeMfaCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - OperatorRevokeMfaCmd.Flags().StringVar(&OperatorRevokeMfaCmdPassword, "password", "", TRAPI("Root user's password")) + OperatorRevokeMfaCmd.Flags().StringVar(&OperatorRevokeMfaCmdPassword, "password", "", TRAPI("Root user's password.")) OperatorRevokeMfaCmd.Flags().StringVar(&OperatorRevokeMfaCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/operator_revoke_operator_auth_tokens.go b/soracom/generated/cmd/operator_revoke_operator_auth_tokens.go index 595a83ac..36252caf 100644 --- a/soracom/generated/cmd/operator_revoke_operator_auth_tokens.go +++ b/soracom/generated/cmd/operator_revoke_operator_auth_tokens.go @@ -13,7 +13,7 @@ import ( var OperatorRevokeOperatorAuthTokensCmdOperatorId string func InitOperatorRevokeOperatorAuthTokensCmd() { - OperatorRevokeOperatorAuthTokensCmd.Flags().StringVar(&OperatorRevokeOperatorAuthTokensCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorRevokeOperatorAuthTokensCmd.Flags().StringVar(&OperatorRevokeOperatorAuthTokensCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorRevokeOperatorAuthTokensCmd.RunE = OperatorRevokeOperatorAuthTokensCmdRunE diff --git a/soracom/generated/cmd/operator_update_company_information.go b/soracom/generated/cmd/operator_update_company_information.go index 59d8f58c..8a649bb8 100644 --- a/soracom/generated/cmd/operator_update_company_information.go +++ b/soracom/generated/cmd/operator_update_company_information.go @@ -72,7 +72,7 @@ func InitOperatorUpdateCompanyInformationCmd() { OperatorUpdateCompanyInformationCmd.Flags().StringVar(&OperatorUpdateCompanyInformationCmdDepartment, "department", "", TRAPI("")) - OperatorUpdateCompanyInformationCmd.Flags().StringVar(&OperatorUpdateCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorUpdateCompanyInformationCmd.Flags().StringVar(&OperatorUpdateCompanyInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorUpdateCompanyInformationCmd.Flags().StringVar(&OperatorUpdateCompanyInformationCmdPhoneNumber, "phone-number", "", TRAPI("")) diff --git a/soracom/generated/cmd/operator_update_individual_information.go b/soracom/generated/cmd/operator_update_individual_information.go index 33625eb2..bd6d18eb 100644 --- a/soracom/generated/cmd/operator_update_individual_information.go +++ b/soracom/generated/cmd/operator_update_individual_information.go @@ -59,7 +59,7 @@ func InitOperatorUpdateIndividualInformationCmd() { OperatorUpdateIndividualInformationCmd.Flags().StringVar(&OperatorUpdateIndividualInformationCmdFullName, "full-name", "", TRAPI("")) - OperatorUpdateIndividualInformationCmd.Flags().StringVar(&OperatorUpdateIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorUpdateIndividualInformationCmd.Flags().StringVar(&OperatorUpdateIndividualInformationCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorUpdateIndividualInformationCmd.Flags().StringVar(&OperatorUpdateIndividualInformationCmdPhoneNumber, "phone-number", "", TRAPI("")) diff --git a/soracom/generated/cmd/operator_update_password.go b/soracom/generated/cmd/operator_update_password.go index efaa1642..e7942503 100644 --- a/soracom/generated/cmd/operator_update_password.go +++ b/soracom/generated/cmd/operator_update_password.go @@ -30,7 +30,7 @@ func InitOperatorUpdatePasswordCmd() { OperatorUpdatePasswordCmd.Flags().StringVar(&OperatorUpdatePasswordCmdNewPassword, "new-password", "", TRAPI("")) - OperatorUpdatePasswordCmd.Flags().StringVar(&OperatorUpdatePasswordCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorUpdatePasswordCmd.Flags().StringVar(&OperatorUpdatePasswordCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorUpdatePasswordCmd.Flags().StringVar(&OperatorUpdatePasswordCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/operator_verify.go b/soracom/generated/cmd/operator_verify.go deleted file mode 100644 index be540435..00000000 --- a/soracom/generated/cmd/operator_verify.go +++ /dev/null @@ -1,162 +0,0 @@ -// Code generated by soracom-cli generate-cmd. DO NOT EDIT. -package cmd - -import ( - "encoding/json" - "fmt" - "io" - "net/url" - "os" - - "strings" - - "github.com/spf13/cobra" -) - -// OperatorVerifyCmdToken holds value of 'token' option -var OperatorVerifyCmdToken string - -// OperatorVerifyCmdBody holds contents of request body to be sent -var OperatorVerifyCmdBody string - -func InitOperatorVerifyCmd() { - OperatorVerifyCmd.Flags().StringVar(&OperatorVerifyCmdToken, "token", "", TRAPI("")) - - OperatorVerifyCmd.Flags().StringVar(&OperatorVerifyCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) - - OperatorVerifyCmd.RunE = OperatorVerifyCmdRunE - - OperatorCmd.AddCommand(OperatorVerifyCmd) -} - -// OperatorVerifyCmd defines 'verify' subcommand -var OperatorVerifyCmd = &cobra.Command{ - Use: "verify", - Short: TRAPI("/operators/verify:post:summary"), - Long: TRAPI(`/operators/verify:post:description`) + "\n\n" + createLinkToAPIReference("Operator", "verifyOperator"), -} - -func OperatorVerifyCmdRunE(cmd *cobra.Command, args []string) error { - - if len(args) > 0 { - return fmt.Errorf("unexpected arguments passed => %v", args) - } - - opt := &apiClientOptions{ - BasePath: "/v1", - Language: getSelectedLanguage(), - } - - ac := newAPIClient(opt) - if v := os.Getenv("SORACOM_VERBOSE"); v != "" { - ac.SetVerbose(true) - } - - param, err := collectOperatorVerifyCmdParams(ac) - if err != nil { - return err - } - - body, err := ac.callAPI(param) - if err != nil { - cmd.SilenceUsage = true - return err - } - - if body == "" { - return nil - } - - if rawOutput { - _, err = os.Stdout.Write([]byte(body)) - } else { - return prettyPrintStringAsJSON(body) - } - return err -} - -func collectOperatorVerifyCmdParams(ac *apiClient) (*apiParams, error) { - var body string - var parsedBody interface{} - var err error - body, err = buildBodyForOperatorVerifyCmd() - if err != nil { - return nil, err - } - contentType := "application/json" - - if contentType == "application/json" { - err = json.Unmarshal([]byte(body), &parsedBody) - if err != nil { - return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) - } - } - - err = checkIfRequiredStringParameterIsSupplied("token", "token", "body", parsedBody, OperatorVerifyCmdToken) - if err != nil { - return nil, err - } - - return &apiParams{ - method: "POST", - path: buildPathForOperatorVerifyCmd("/operators/verify"), - query: buildQueryForOperatorVerifyCmd(), - contentType: contentType, - body: body, - - noRetryOnError: noRetryOnError, - }, nil -} - -func buildPathForOperatorVerifyCmd(path string) string { - - return path -} - -func buildQueryForOperatorVerifyCmd() url.Values { - result := url.Values{} - - return result -} - -func buildBodyForOperatorVerifyCmd() (string, error) { - var result map[string]interface{} - - if OperatorVerifyCmdBody != "" { - var b []byte - var err error - - if strings.HasPrefix(OperatorVerifyCmdBody, "@") { - fname := strings.TrimPrefix(OperatorVerifyCmdBody, "@") - // #nosec - b, err = os.ReadFile(fname) - } else if OperatorVerifyCmdBody == "-" { - b, err = io.ReadAll(os.Stdin) - } else { - b = []byte(OperatorVerifyCmdBody) - } - - if err != nil { - return "", err - } - - err = json.Unmarshal(b, &result) - if err != nil { - return "", err - } - } - - if result == nil { - result = make(map[string]interface{}) - } - - if OperatorVerifyCmdToken != "" { - result["token"] = OperatorVerifyCmdToken - } - - resultBytes, err := json.Marshal(result) - if err != nil { - return "", err - } - return string(resultBytes), nil -} diff --git a/soracom/generated/cmd/operator_verify_mfa_otp.go b/soracom/generated/cmd/operator_verify_mfa_otp.go index bfe1ad94..a1764c52 100644 --- a/soracom/generated/cmd/operator_verify_mfa_otp.go +++ b/soracom/generated/cmd/operator_verify_mfa_otp.go @@ -25,7 +25,7 @@ var OperatorVerifyMfaOtpCmdBody string func InitOperatorVerifyMfaOtpCmd() { OperatorVerifyMfaOtpCmd.Flags().StringVar(&OperatorVerifyMfaOtpCmdMfaOTPCode, "mfa-otpcode", "", TRAPI("")) - OperatorVerifyMfaOtpCmd.Flags().StringVar(&OperatorVerifyMfaOtpCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + OperatorVerifyMfaOtpCmd.Flags().StringVar(&OperatorVerifyMfaOtpCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) OperatorVerifyMfaOtpCmd.Flags().StringVar(&OperatorVerifyMfaOtpCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/orders_cancel.go b/soracom/generated/cmd/orders_cancel.go index fdf4551d..1bcf867d 100644 --- a/soracom/generated/cmd/orders_cancel.go +++ b/soracom/generated/cmd/orders_cancel.go @@ -13,7 +13,7 @@ import ( var OrdersCancelCmdOrderId string func InitOrdersCancelCmd() { - OrdersCancelCmd.Flags().StringVar(&OrdersCancelCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersCancelCmd.Flags().StringVar(&OrdersCancelCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersCancelCmd.RunE = OrdersCancelCmdRunE diff --git a/soracom/generated/cmd/orders_confirm.go b/soracom/generated/cmd/orders_confirm.go index 5c0a9c57..e4a3098b 100644 --- a/soracom/generated/cmd/orders_confirm.go +++ b/soracom/generated/cmd/orders_confirm.go @@ -13,7 +13,7 @@ import ( var OrdersConfirmCmdOrderId string func InitOrdersConfirmCmd() { - OrdersConfirmCmd.Flags().StringVar(&OrdersConfirmCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersConfirmCmd.Flags().StringVar(&OrdersConfirmCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersConfirmCmd.RunE = OrdersConfirmCmdRunE diff --git a/soracom/generated/cmd/orders_create.go b/soracom/generated/cmd/orders_create.go index 985564d6..9d7cc2fa 100644 --- a/soracom/generated/cmd/orders_create.go +++ b/soracom/generated/cmd/orders_create.go @@ -23,9 +23,9 @@ var OrdersCreateCmdShippingAddressId string var OrdersCreateCmdBody string func InitOrdersCreateCmd() { - OrdersCreateCmd.Flags().StringVar(&OrdersCreateCmdPreferredDeliveryDate, "preferred-delivery-date", "", TRAPI("Preferred delivery date")) + OrdersCreateCmd.Flags().StringVar(&OrdersCreateCmdPreferredDeliveryDate, "preferred-delivery-date", "", TRAPI("Preferred delivery date.")) - OrdersCreateCmd.Flags().StringVar(&OrdersCreateCmdShippingAddressId, "shipping-address-id", "", TRAPI("Shipping address ID")) + OrdersCreateCmd.Flags().StringVar(&OrdersCreateCmdShippingAddressId, "shipping-address-id", "", TRAPI("Shipping address ID.")) OrdersCreateCmd.Flags().StringVar(&OrdersCreateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/orders_get.go b/soracom/generated/cmd/orders_get.go index da97ac1d..6395bd48 100644 --- a/soracom/generated/cmd/orders_get.go +++ b/soracom/generated/cmd/orders_get.go @@ -13,7 +13,7 @@ import ( var OrdersGetCmdOrderId string func InitOrdersGetCmd() { - OrdersGetCmd.Flags().StringVar(&OrdersGetCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersGetCmd.Flags().StringVar(&OrdersGetCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersGetCmd.RunE = OrdersGetCmdRunE diff --git a/soracom/generated/cmd/orders_list_subscribers.go b/soracom/generated/cmd/orders_list_subscribers.go index 71bb9b5e..bf397fe6 100644 --- a/soracom/generated/cmd/orders_list_subscribers.go +++ b/soracom/generated/cmd/orders_list_subscribers.go @@ -22,9 +22,9 @@ var OrdersListSubscribersCmdLimit int64 var OrdersListSubscribersCmdPaginate bool func InitOrdersListSubscribersCmd() { - OrdersListSubscribersCmd.Flags().StringVar(&OrdersListSubscribersCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("Serial number of the last subscriber in the previous page that is set to response header with X-Soracom-Next-Key.")) + OrdersListSubscribersCmd.Flags().StringVar(&OrdersListSubscribersCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The value of the 'x-soracom-next-key' header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination).")) - OrdersListSubscribersCmd.Flags().StringVar(&OrdersListSubscribersCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersListSubscribersCmd.Flags().StringVar(&OrdersListSubscribersCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersListSubscribersCmd.Flags().Int64Var(&OrdersListSubscribersCmdLimit, "limit", 0, TRAPI("Max number of subscribers in a response.")) diff --git a/soracom/generated/cmd/orders_register_subscribers.go b/soracom/generated/cmd/orders_register_subscribers.go index 4719e3fe..44a91365 100644 --- a/soracom/generated/cmd/orders_register_subscribers.go +++ b/soracom/generated/cmd/orders_register_subscribers.go @@ -13,7 +13,7 @@ import ( var OrdersRegisterSubscribersCmdOrderId string func InitOrdersRegisterSubscribersCmd() { - OrdersRegisterSubscribersCmd.Flags().StringVar(&OrdersRegisterSubscribersCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersRegisterSubscribersCmd.Flags().StringVar(&OrdersRegisterSubscribersCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersRegisterSubscribersCmd.RunE = OrdersRegisterSubscribersCmdRunE diff --git a/soracom/generated/cmd/orders_resource_initial_setting_update.go b/soracom/generated/cmd/orders_resource_initial_setting_update.go index 4f0ab9d5..d318e14b 100644 --- a/soracom/generated/cmd/orders_resource_initial_setting_update.go +++ b/soracom/generated/cmd/orders_resource_initial_setting_update.go @@ -20,7 +20,7 @@ var OrdersResourceInitialSettingUpdateCmdOrderId string var OrdersResourceInitialSettingUpdateCmdBody string func InitOrdersResourceInitialSettingUpdateCmd() { - OrdersResourceInitialSettingUpdateCmd.Flags().StringVar(&OrdersResourceInitialSettingUpdateCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#/Order/listOrders).")) + OrdersResourceInitialSettingUpdateCmd.Flags().StringVar(&OrdersResourceInitialSettingUpdateCmdOrderId, "order-id", "", TRAPI("Order ID. You can get it by calling ['Order:listOrders API'](#!/Order/listOrders).")) OrdersResourceInitialSettingUpdateCmd.Flags().StringVar(&OrdersResourceInitialSettingUpdateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/payer_information_register.go b/soracom/generated/cmd/payer_information_register.go index 4a116ed8..7eb33a2f 100644 --- a/soracom/generated/cmd/payer_information_register.go +++ b/soracom/generated/cmd/payer_information_register.go @@ -28,9 +28,9 @@ var PayerInformationRegisterCmdBody string func InitPayerInformationRegisterCmd() { PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdCompanyName, "company-name", "", TRAPI("Company name")) - PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdDepartment, "department", "", TRAPI("Department")) + PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdDepartment, "department", "", TRAPI("Department.")) - PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdFullName, "full-name", "", TRAPI("Full name")) + PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdFullName, "full-name", "", TRAPI("Full name.")) PayerInformationRegisterCmd.Flags().StringVar(&PayerInformationRegisterCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/payment_history_get.go b/soracom/generated/cmd/payment_history_get.go index aa24703a..36848aa2 100644 --- a/soracom/generated/cmd/payment_history_get.go +++ b/soracom/generated/cmd/payment_history_get.go @@ -13,7 +13,7 @@ import ( var PaymentHistoryGetCmdPaymentTransactionId string func InitPaymentHistoryGetCmd() { - PaymentHistoryGetCmd.Flags().StringVar(&PaymentHistoryGetCmdPaymentTransactionId, "payment-transaction-id", "", TRAPI("Payment transaction ID. It can be obtained via [Billing:getBillingHistory API](#/Billing/getBillingHistory) or [Billing:getBilling API](#/Billing/getBilling).")) + PaymentHistoryGetCmd.Flags().StringVar(&PaymentHistoryGetCmdPaymentTransactionId, "payment-transaction-id", "", TRAPI("Payment transaction ID. It can be obtained via [Billing:getBillingHistory API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling).")) PaymentHistoryGetCmd.RunE = PaymentHistoryGetCmdRunE diff --git a/soracom/generated/cmd/port_mappings_delete.go b/soracom/generated/cmd/port_mappings_delete.go index 3ccd0b88..738f5c5e 100644 --- a/soracom/generated/cmd/port_mappings_delete.go +++ b/soracom/generated/cmd/port_mappings_delete.go @@ -16,9 +16,9 @@ var PortMappingsDeleteCmdIpAddress string var PortMappingsDeleteCmdPort string func InitPortMappingsDeleteCmd() { - PortMappingsDeleteCmd.Flags().StringVar(&PortMappingsDeleteCmdIpAddress, "ip-address", "", TRAPI("IP address of the target port mapping entry")) + PortMappingsDeleteCmd.Flags().StringVar(&PortMappingsDeleteCmdIpAddress, "ip-address", "", TRAPI("IP address of the target port mapping entry.")) - PortMappingsDeleteCmd.Flags().StringVar(&PortMappingsDeleteCmdPort, "port", "", TRAPI("Port of the target port mapping entry")) + PortMappingsDeleteCmd.Flags().StringVar(&PortMappingsDeleteCmdPort, "port", "", TRAPI("Port of the target port mapping entry.")) PortMappingsDeleteCmd.RunE = PortMappingsDeleteCmdRunE diff --git a/soracom/generated/cmd/port_mappings_get.go b/soracom/generated/cmd/port_mappings_get.go index c1dc96d5..fa436bfc 100644 --- a/soracom/generated/cmd/port_mappings_get.go +++ b/soracom/generated/cmd/port_mappings_get.go @@ -13,7 +13,7 @@ import ( var PortMappingsGetCmdImsi string func InitPortMappingsGetCmd() { - PortMappingsGetCmd.Flags().StringVar(&PortMappingsGetCmdImsi, "imsi", "", TRAPI("Target subscriber IMSI.")) + PortMappingsGetCmd.Flags().StringVar(&PortMappingsGetCmdImsi, "imsi", "", TRAPI("IMSI of the target subscriber.")) PortMappingsGetCmd.RunE = PortMappingsGetCmdRunE diff --git a/soracom/generated/cmd/port_mappings_list.go b/soracom/generated/cmd/port_mappings_list.go index 15f6fdae..575e3d06 100644 --- a/soracom/generated/cmd/port_mappings_list.go +++ b/soracom/generated/cmd/port_mappings_list.go @@ -22,7 +22,7 @@ var PortMappingsListCmdPaginate bool var PortMappingsListCmdOutputJSONL bool func InitPortMappingsListCmd() { - PortMappingsListCmd.Flags().StringVar(&PortMappingsListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The last Port Mapping ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next group onward.")) + PortMappingsListCmd.Flags().StringVar(&PortMappingsListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The last Port Mapping ID retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next entry onward.")) PortMappingsListCmd.Flags().Int64Var(&PortMappingsListCmdLimit, "limit", 0, TRAPI("Maximum number of results per response page.")) diff --git a/soracom/generated/cmd/products_list.go b/soracom/generated/cmd/products_list.go index fc16ecc7..d43295b1 100644 --- a/soracom/generated/cmd/products_list.go +++ b/soracom/generated/cmd/products_list.go @@ -9,7 +9,11 @@ import ( "github.com/spf13/cobra" ) +// ProductsListCmdCampaignCode holds value of 'campaign_code' option +var ProductsListCmdCampaignCode string + func InitProductsListCmd() { + ProductsListCmd.Flags().StringVar(&ProductsListCmdCampaignCode, "campaign-code", "", TRAPI("")) ProductsListCmd.RunE = ProductsListCmdRunE @@ -86,5 +90,9 @@ func buildPathForProductsListCmd(path string) string { func buildQueryForProductsListCmd() url.Values { result := url.Values{} + if ProductsListCmdCampaignCode != "" { + result.Add("campaign_code", ProductsListCmdCampaignCode) + } + return result } diff --git a/soracom/generated/cmd/query_devices.go b/soracom/generated/cmd/query_devices.go index 3110f198..398e24b7 100644 --- a/soracom/generated/cmd/query_devices.go +++ b/soracom/generated/cmd/query_devices.go @@ -43,23 +43,23 @@ var QueryDevicesCmdPaginate bool var QueryDevicesCmdOutputJSONL bool func InitQueryDevicesCmd() { - QueryDevicesCmd.Flags().StringVar(&QueryDevicesCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The SORACOM Inventory device ID of the last Inventory device retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward.")) + QueryDevicesCmd.Flags().StringVar(&QueryDevicesCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The SORACOM Inventory device ID of the last Inventory device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward.")) - QueryDevicesCmd.Flags().StringVar(&QueryDevicesCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching')")) + QueryDevicesCmd.Flags().StringVar(&QueryDevicesCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching').")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdDeviceId, "device-id", []string{}, TRAPI("SORACOM Inventory device ID to search")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdDeviceId, "device-id", []string{}, TRAPI("SORACOM Inventory device ID to search.")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdGroup, "group", []string{}, TRAPI("Group name to search")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdGroup, "group", []string{}, TRAPI("Group name to search.")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdImei, "imei", []string{}, TRAPI("IMEI of the device that was used on bootstrapping")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdImei, "imei", []string{}, TRAPI("IMEI of the device that was used on bootstrapping.")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdImsi, "imsi", []string{}, TRAPI("IMSI of the device that was used on bootstrapping")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdImsi, "imsi", []string{}, TRAPI("IMSI of the device that was used on bootstrapping.")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdName, "name", []string{}, TRAPI("Name to search")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdName, "name", []string{}, TRAPI("Name to search.")) - QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdTag, "tag", []string{}, TRAPI("String of tag values to search")) + QueryDevicesCmd.Flags().StringSliceVar(&QueryDevicesCmdTag, "tag", []string{}, TRAPI("String of tag values to search.")) - QueryDevicesCmd.Flags().Int64Var(&QueryDevicesCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QueryDevicesCmd.Flags().Int64Var(&QueryDevicesCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) QueryDevicesCmd.Flags().BoolVar(&QueryDevicesCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/query_sigfox_devices.go b/soracom/generated/cmd/query_sigfox_devices.go index d997cf38..f6d9f1b2 100644 --- a/soracom/generated/cmd/query_sigfox_devices.go +++ b/soracom/generated/cmd/query_sigfox_devices.go @@ -43,23 +43,23 @@ var QuerySigfoxDevicesCmdPaginate bool var QuerySigfoxDevicesCmdOutputJSONL bool func InitQuerySigfoxDevicesCmd() { - QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The Sigfox device ID of the last Sigfox device retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.")) + QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The Sigfox device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward.")) - QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdRegistration, "registration", "and", TRAPI("Registration status of sigfox devices")) + QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdRegistration, "registration", "and", TRAPI("Registration status of sigfox devices.")) - QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching')")) + QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching').")) - QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdStatus, "status", "and", TRAPI("Status of sigfox devices")) + QuerySigfoxDevicesCmd.Flags().StringVar(&QuerySigfoxDevicesCmdStatus, "status", "and", TRAPI("Status of sigfox devices.")) - QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdDeviceId, "device-id", []string{}, TRAPI("Sigfox device ID to search")) + QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdDeviceId, "device-id", []string{}, TRAPI("Sigfox device ID to search.")) - QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdGroup, "group", []string{}, TRAPI("Group name to search")) + QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdGroup, "group", []string{}, TRAPI("Group name to search.")) - QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdName, "name", []string{}, TRAPI("Name to search")) + QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdName, "name", []string{}, TRAPI("Name to search.")) - QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdTag, "tag", []string{}, TRAPI("String of tag values to search")) + QuerySigfoxDevicesCmd.Flags().StringSliceVar(&QuerySigfoxDevicesCmdTag, "tag", []string{}, TRAPI("String of tag values to search.")) - QuerySigfoxDevicesCmd.Flags().Int64Var(&QuerySigfoxDevicesCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QuerySigfoxDevicesCmd.Flags().Int64Var(&QuerySigfoxDevicesCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) QuerySigfoxDevicesCmd.Flags().BoolVar(&QuerySigfoxDevicesCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/query_sims.go b/soracom/generated/cmd/query_sims.go index b1e34a5d..2bffc341 100644 --- a/soracom/generated/cmd/query_sims.go +++ b/soracom/generated/cmd/query_sims.go @@ -55,31 +55,31 @@ var QuerySimsCmdPaginate bool var QuerySimsCmdOutputJSONL bool func InitQuerySimsCmd() { - QuerySimsCmd.Flags().StringVar(&QuerySimsCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The SIM ID of the last SIM retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward.")) + QuerySimsCmd.Flags().StringVar(&QuerySimsCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward.")) - QuerySimsCmd.Flags().StringVar(&QuerySimsCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching')")) + QuerySimsCmd.Flags().StringVar(&QuerySimsCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching'). If omitted, it is an AND search.")) - QuerySimsCmd.Flags().StringVar(&QuerySimsCmdSessionStatus, "session-status", "NA", TRAPI("Status of the session to search (ONLINE or OFFLINE)")) + QuerySimsCmd.Flags().StringVar(&QuerySimsCmdSessionStatus, "session-status", "NA", TRAPI("Status of the session to search (ONLINE or OFFLINE).- 'NA': Any.- 'ONLINE': Online.- 'OFFLINE': Offline.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdBundles, "bundles", []string{}, TRAPI("Bundles type to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdBundles, "bundles", []string{}, TRAPI("Bundles type to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdGroup, "group", []string{}, TRAPI("Group name to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdGroup, "group", []string{}, TRAPI("Group name to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdIccid, "iccid", []string{}, TRAPI("ICCID to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdIccid, "iccid", []string{}, TRAPI("ICCID to search. An identifier to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber).")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdImsi, "imsi", []string{}, TRAPI("IMSI to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdImsi, "imsi", []string{}, TRAPI("IMSI to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdMsisdn, "msisdn", []string{}, TRAPI("MSISDN to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdMsisdn, "msisdn", []string{}, TRAPI("MSISDN to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdName, "name", []string{}, TRAPI("Name to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdName, "name", []string{}, TRAPI("Name to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdSerialNumber, "serial-number", []string{}, TRAPI("Serial number to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdSerialNumber, "serial-number", []string{}, TRAPI("Serial number to search. This is set only for IoT SIMs for specific regions.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdSimId, "sim-id", []string{}, TRAPI("Identifier of the SIM to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdSimId, "sim-id", []string{}, TRAPI("Identifier of the SIM to search.")) - QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdTag, "tag", []string{}, TRAPI("String of tag values to search")) + QuerySimsCmd.Flags().StringSliceVar(&QuerySimsCmdTag, "tag", []string{}, TRAPI("String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags).")) - QuerySimsCmd.Flags().Int64Var(&QuerySimsCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QuerySimsCmd.Flags().Int64Var(&QuerySimsCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) QuerySimsCmd.Flags().BoolVar(&QuerySimsCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/query_subscribers.go b/soracom/generated/cmd/query_subscribers.go index 6900de6d..d91be2c8 100644 --- a/soracom/generated/cmd/query_subscribers.go +++ b/soracom/generated/cmd/query_subscribers.go @@ -54,29 +54,29 @@ var QuerySubscribersCmdPaginate bool var QuerySubscribersCmdOutputJSONL bool func InitQuerySubscribersCmd() { - QuerySubscribersCmd.Flags().StringVar(&QuerySubscribersCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The IMSI of the last subscriber retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward.")) + QuerySubscribersCmd.Flags().StringVar(&QuerySubscribersCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward.")) - QuerySubscribersCmd.Flags().StringVar(&QuerySubscribersCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching')")) + QuerySubscribersCmd.Flags().StringVar(&QuerySubscribersCmdSearchType, "search-type", "and", TRAPI("Type of the search ('AND searching' or 'OR searching').")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdGroup, "group", []string{}, TRAPI("Group name to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdGroup, "group", []string{}, TRAPI("Group name to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdIccid, "iccid", []string{}, TRAPI("ICCID to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdIccid, "iccid", []string{}, TRAPI("ICCID to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdImsi, "imsi", []string{}, TRAPI("IMSI to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdImsi, "imsi", []string{}, TRAPI("IMSI to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdModuleType, "module-type", []string{}, TRAPI("Module type (e.g. 'mini', 'virtual') to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdModuleType, "module-type", []string{}, TRAPI("Module type (e.g. 'mini', 'virtual') to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdMsisdn, "msisdn", []string{}, TRAPI("MSISDN to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdMsisdn, "msisdn", []string{}, TRAPI("MSISDN to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdName, "name", []string{}, TRAPI("Name to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdName, "name", []string{}, TRAPI("Name to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdSerialNumber, "serial-number", []string{}, TRAPI("Serial number to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdSerialNumber, "serial-number", []string{}, TRAPI("Serial number to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdSubscription, "subscription", []string{}, TRAPI("Subscription (e.g. 'plan01s') to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdSubscription, "subscription", []string{}, TRAPI("Subscription (e.g. 'plan01s') to search.")) - QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdTag, "tag", []string{}, TRAPI("String of tag values to search")) + QuerySubscribersCmd.Flags().StringSliceVar(&QuerySubscribersCmdTag, "tag", []string{}, TRAPI("String of tag values to search.")) - QuerySubscribersCmd.Flags().Int64Var(&QuerySubscribersCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QuerySubscribersCmd.Flags().Int64Var(&QuerySubscribersCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) QuerySubscribersCmd.Flags().BoolVar(&QuerySubscribersCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/query_subscribers_traffic_volume_ranking.go b/soracom/generated/cmd/query_subscribers_traffic_volume_ranking.go index 3039096d..29431fa5 100644 --- a/soracom/generated/cmd/query_subscribers_traffic_volume_ranking.go +++ b/soracom/generated/cmd/query_subscribers_traffic_volume_ranking.go @@ -25,13 +25,13 @@ var QuerySubscribersTrafficVolumeRankingCmdTo int64 var QuerySubscribersTrafficVolumeRankingCmdOutputJSONL bool func InitQuerySubscribersTrafficVolumeRankingCmd() { - QuerySubscribersTrafficVolumeRankingCmd.Flags().StringVar(&QuerySubscribersTrafficVolumeRankingCmdOrder, "order", "desc", TRAPI("The order of ranking")) + QuerySubscribersTrafficVolumeRankingCmd.Flags().StringVar(&QuerySubscribersTrafficVolumeRankingCmdOrder, "order", "desc", TRAPI("The order of ranking.")) - QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdFrom, "from", 0, TRAPI("The beginning point of searching range (unixtime: in milliseconds)")) + QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdFrom, "from", 0, TRAPI("The beginning point of searching range (UNIX time in milliseconds).")) - QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) - QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdTo, "to", 0, TRAPI("The end point of searching range (unixtime: in milliseconds)")) + QuerySubscribersTrafficVolumeRankingCmd.Flags().Int64Var(&QuerySubscribersTrafficVolumeRankingCmdTo, "to", 0, TRAPI("The end point of searching range (UNIX time in milliseconds).")) QuerySubscribersTrafficVolumeRankingCmd.Flags().BoolVar(&QuerySubscribersTrafficVolumeRankingCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/query_traffic_ranking.go b/soracom/generated/cmd/query_traffic_ranking.go index 75ab7291..cf821a17 100644 --- a/soracom/generated/cmd/query_traffic_ranking.go +++ b/soracom/generated/cmd/query_traffic_ranking.go @@ -25,13 +25,13 @@ var QueryTrafficRankingCmdTo int64 var QueryTrafficRankingCmdOutputJSONL bool func InitQueryTrafficRankingCmd() { - QueryTrafficRankingCmd.Flags().StringVar(&QueryTrafficRankingCmdOrder, "order", "desc", TRAPI("The order of ranking")) + QueryTrafficRankingCmd.Flags().StringVar(&QueryTrafficRankingCmdOrder, "order", "desc", TRAPI("The order of ranking.")) - QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdFrom, "from", 0, TRAPI("The beginning point of searching range (unixtime: in milliseconds)")) + QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdFrom, "from", 0, TRAPI("The beginning point of searching range (UNIX time in milliseconds).")) - QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve")) + QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdLimit, "limit", 10, TRAPI("The maximum number of item to retrieve.")) - QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdTo, "to", 0, TRAPI("The end point of searching range (unixtime: in milliseconds)")) + QueryTrafficRankingCmd.Flags().Int64Var(&QueryTrafficRankingCmdTo, "to", 0, TRAPI("The end point of searching range (UNIX time in milliseconds).")) QueryTrafficRankingCmd.Flags().BoolVar(&QueryTrafficRankingCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/resource_summaries_get.go b/soracom/generated/cmd/resource_summaries_get.go index 8bb7c964..956e3030 100644 --- a/soracom/generated/cmd/resource_summaries_get.go +++ b/soracom/generated/cmd/resource_summaries_get.go @@ -13,7 +13,7 @@ import ( var ResourceSummariesGetCmdResourceSummaryType string func InitResourceSummariesGetCmd() { - ResourceSummariesGetCmd.Flags().StringVar(&ResourceSummariesGetCmdResourceSummaryType, "resource-summary-type", "", TRAPI("The type of the resource summary.- 'simsPerStatus': The number of IoT SIMs per status")) + ResourceSummariesGetCmd.Flags().StringVar(&ResourceSummariesGetCmdResourceSummaryType, "resource-summary-type", "", TRAPI("The type of the resource summary.- 'simsPerStatus': The number of IoT SIMs per status.")) ResourceSummariesGetCmd.RunE = ResourceSummariesGetCmdRunE diff --git a/soracom/generated/cmd/roles_create.go b/soracom/generated/cmd/roles_create.go index 4b258aac..97a72277 100644 --- a/soracom/generated/cmd/roles_create.go +++ b/soracom/generated/cmd/roles_create.go @@ -31,11 +31,11 @@ var RolesCreateCmdBody string func InitRolesCreateCmd() { RolesCreateCmd.Flags().StringVar(&RolesCreateCmdDescription, "description", "", TRAPI("")) - RolesCreateCmd.Flags().StringVar(&RolesCreateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesCreateCmd.Flags().StringVar(&RolesCreateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - RolesCreateCmd.Flags().StringVar(&RolesCreateCmdPermission, "permission", "", TRAPI("Permission as JSON")) + RolesCreateCmd.Flags().StringVar(&RolesCreateCmdPermission, "permission", "", TRAPI("Permission as JSON.")) - RolesCreateCmd.Flags().StringVar(&RolesCreateCmdRoleId, "role-id", "", TRAPI("role_id")) + RolesCreateCmd.Flags().StringVar(&RolesCreateCmdRoleId, "role-id", "", TRAPI("Role ID.")) RolesCreateCmd.Flags().StringVar(&RolesCreateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/roles_delete.go b/soracom/generated/cmd/roles_delete.go index 23721c9d..71322f0f 100644 --- a/soracom/generated/cmd/roles_delete.go +++ b/soracom/generated/cmd/roles_delete.go @@ -16,9 +16,9 @@ var RolesDeleteCmdOperatorId string var RolesDeleteCmdRoleId string func InitRolesDeleteCmd() { - RolesDeleteCmd.Flags().StringVar(&RolesDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesDeleteCmd.Flags().StringVar(&RolesDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - RolesDeleteCmd.Flags().StringVar(&RolesDeleteCmdRoleId, "role-id", "", TRAPI("role_id")) + RolesDeleteCmd.Flags().StringVar(&RolesDeleteCmdRoleId, "role-id", "", TRAPI("Role ID.")) RolesDeleteCmd.RunE = RolesDeleteCmdRunE diff --git a/soracom/generated/cmd/roles_get.go b/soracom/generated/cmd/roles_get.go index d72b784e..e4a5286b 100644 --- a/soracom/generated/cmd/roles_get.go +++ b/soracom/generated/cmd/roles_get.go @@ -16,9 +16,9 @@ var RolesGetCmdOperatorId string var RolesGetCmdRoleId string func InitRolesGetCmd() { - RolesGetCmd.Flags().StringVar(&RolesGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesGetCmd.Flags().StringVar(&RolesGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - RolesGetCmd.Flags().StringVar(&RolesGetCmdRoleId, "role-id", "", TRAPI("role_id")) + RolesGetCmd.Flags().StringVar(&RolesGetCmdRoleId, "role-id", "", TRAPI("Role ID.")) RolesGetCmd.RunE = RolesGetCmdRunE diff --git a/soracom/generated/cmd/roles_list.go b/soracom/generated/cmd/roles_list.go index d0fcb4ff..4c964f3a 100644 --- a/soracom/generated/cmd/roles_list.go +++ b/soracom/generated/cmd/roles_list.go @@ -16,7 +16,7 @@ var RolesListCmdOperatorId string var RolesListCmdOutputJSONL bool func InitRolesListCmd() { - RolesListCmd.Flags().StringVar(&RolesListCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesListCmd.Flags().StringVar(&RolesListCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) RolesListCmd.Flags().BoolVar(&RolesListCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/roles_list_users.go b/soracom/generated/cmd/roles_list_users.go index eb7411aa..b9d1df71 100644 --- a/soracom/generated/cmd/roles_list_users.go +++ b/soracom/generated/cmd/roles_list_users.go @@ -19,9 +19,9 @@ var RolesListUsersCmdRoleId string var RolesListUsersCmdOutputJSONL bool func InitRolesListUsersCmd() { - RolesListUsersCmd.Flags().StringVar(&RolesListUsersCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesListUsersCmd.Flags().StringVar(&RolesListUsersCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - RolesListUsersCmd.Flags().StringVar(&RolesListUsersCmdRoleId, "role-id", "", TRAPI("role_id")) + RolesListUsersCmd.Flags().StringVar(&RolesListUsersCmdRoleId, "role-id", "", TRAPI("Role ID.")) RolesListUsersCmd.Flags().BoolVar(&RolesListUsersCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/roles_update.go b/soracom/generated/cmd/roles_update.go index 0338806e..434cdc52 100644 --- a/soracom/generated/cmd/roles_update.go +++ b/soracom/generated/cmd/roles_update.go @@ -31,11 +31,11 @@ var RolesUpdateCmdBody string func InitRolesUpdateCmd() { RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdDescription, "description", "", TRAPI("")) - RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdPermission, "permission", "", TRAPI("Permission as JSON")) + RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdPermission, "permission", "", TRAPI("Permission as JSON.")) - RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdRoleId, "role-id", "", TRAPI("role_id")) + RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdRoleId, "role-id", "", TRAPI("Role ID.")) RolesUpdateCmd.Flags().StringVar(&RolesUpdateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/root.go b/soracom/generated/cmd/root.go index 17676907..e294a0ba 100644 --- a/soracom/generated/cmd/root.go +++ b/soracom/generated/cmd/root.go @@ -193,7 +193,6 @@ func InitAllSubCommands() { InitOperatorConfigurationDeleteCmd() InitOperatorConfigurationGetCmd() InitOperatorConfigurationSetCmd() - InitOperatorCreateCmd() InitOperatorCreateCompanyInformationCmd() InitOperatorCreateIndividualInformationCmd() InitOperatorDeleteContractCmd() @@ -210,7 +209,6 @@ func InitAllSubCommands() { InitOperatorUpdateCompanyInformationCmd() InitOperatorUpdateIndividualInformationCmd() InitOperatorUpdatePasswordCmd() - InitOperatorVerifyCmd() InitOperatorVerifyMfaOtpCmd() InitOperatorVerifyMfaRevokeTokenCmd() InitOrdersCancelCmd() @@ -290,6 +288,7 @@ func InitAllSubCommands() { InitSimsGetPacketCaptureSessionCmd() InitSimsListCmd() InitSimsListPacketCaptureSessionsCmd() + InitSimsListStatusHistoryCmd() InitSimsPutTagsCmd() InitSimsRegisterCmd() InitSimsRemoveArcCredentialsCmd() @@ -309,17 +308,38 @@ func InitAllSubCommands() { InitSimsUnsetGroupCmd() InitSimsUnsetImeiLockCmd() InitSimsUpdateSpeedClassCmd() + InitSoraCamDevicesAtomcamGetSettingsCmd() + InitSoraCamDevicesAtomcamSettingsGetLogoCmd() + InitSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd() + InitSoraCamDevicesAtomcamSettingsGetNightVisionCmd() + InitSoraCamDevicesAtomcamSettingsGetQualityCmd() + InitSoraCamDevicesAtomcamSettingsGetRotationCmd() + InitSoraCamDevicesAtomcamSettingsGetStatusLightCmd() + InitSoraCamDevicesAtomcamSettingsGetTimestampCmd() + InitSoraCamDevicesAtomcamSettingsSetLogoCmd() + InitSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd() + InitSoraCamDevicesAtomcamSettingsSetNightVisionCmd() + InitSoraCamDevicesAtomcamSettingsSetQualityCmd() + InitSoraCamDevicesAtomcamSettingsSetRotationCmd() + InitSoraCamDevicesAtomcamSettingsSetStatusLightCmd() + InitSoraCamDevicesAtomcamSettingsSetTimestampCmd() InitSoraCamDevicesDeleteExportUsageLimitOverrideCmd() InitSoraCamDevicesEventsListCmd() InitSoraCamDevicesEventsListForDeviceCmd() InitSoraCamDevicesGetCmd() InitSoraCamDevicesGetExportUsageCmd() + InitSoraCamDevicesGetNameCmd() + InitSoraCamDevicesGetPowerStateCmd() InitSoraCamDevicesGetStreamingVideoCmd() InitSoraCamDevicesImagesExportCmd() InitSoraCamDevicesImagesGetExportedCmd() InitSoraCamDevicesImagesListExportsCmd() InitSoraCamDevicesImagesListExportsForDeviceCmd() InitSoraCamDevicesListCmd() + InitSoraCamDevicesRebootCmd() + InitSoraCamDevicesRecordingsAndEventsListForDeviceCmd() + InitSoraCamDevicesSetNameCmd() + InitSoraCamDevicesSetPowerStateCmd() InitSoraCamDevicesUpdateExportUsageLimitOverrideCmd() InitSoraCamDevicesVideosExportCmd() InitSoraCamDevicesVideosGetExportedCmd() @@ -348,6 +368,7 @@ func InitAllSubCommands() { InitStatsFunkGetCmd() InitStatsFunnelExportCmd() InitStatsFunnelGetCmd() + InitStatsHarvestExportCmd() InitStatsHarvestOperatorsGetCmd() InitStatsHarvestSubscribersGetCmd() InitStatsNapterAuditLogsGetCmd() diff --git a/soracom/generated/cmd/sandbox_coupons_create.go b/soracom/generated/cmd/sandbox_coupons_create.go index e34dbefc..bce4281e 100644 --- a/soracom/generated/cmd/sandbox_coupons_create.go +++ b/soracom/generated/cmd/sandbox_coupons_create.go @@ -43,7 +43,7 @@ func InitSandboxCouponsCreateCmd() { var SandboxCouponsCreateCmd = &cobra.Command{ Use: "create", Short: TRAPI("/sandbox/coupons/create:post:summary"), - Long: TRAPI(`/sandbox/coupons/create:post:description`) + "\n\n" + createLinkToAPIReference("Coupon", "sandboxCreateCoupon"), + Long: TRAPI(`/sandbox/coupons/create:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Coupon", "sandboxCreateCoupon"), } func SandboxCouponsCreateCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_init.go b/soracom/generated/cmd/sandbox_init.go index ec84ffe5..b8cca48e 100644 --- a/soracom/generated/cmd/sandbox_init.go +++ b/soracom/generated/cmd/sandbox_init.go @@ -58,7 +58,7 @@ func InitSandboxInitCmd() { var SandboxInitCmd = &cobra.Command{ Use: "init", Short: TRAPI("/sandbox/init:post:summary"), - Long: TRAPI(`/sandbox/init:post:description`) + "\n\n" + createLinkToAPIReference("Operator", "sandboxInitializeOperator"), + Long: TRAPI(`/sandbox/init:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Operator", "sandboxInitializeOperator"), } func SandboxInitCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_operators_delete.go b/soracom/generated/cmd/sandbox_operators_delete.go index 7ca2ae8b..75eb0f16 100644 --- a/soracom/generated/cmd/sandbox_operators_delete.go +++ b/soracom/generated/cmd/sandbox_operators_delete.go @@ -24,7 +24,7 @@ func InitSandboxOperatorsDeleteCmd() { var SandboxOperatorsDeleteCmd = &cobra.Command{ Use: "delete", Short: TRAPI("/sandbox/operators/{operator_id}:delete:summary"), - Long: TRAPI(`/sandbox/operators/{operator_id}:delete:description`) + "\n\n" + createLinkToAPIReference("Operator", "sandboxDeleteOperator"), + Long: TRAPI(`/sandbox/operators/{operator_id}:delete:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Operator", "sandboxDeleteOperator"), } func SandboxOperatorsDeleteCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_operators_get_signup_token.go b/soracom/generated/cmd/sandbox_operators_get_signup_token.go index abbfb86b..af1f1773 100644 --- a/soracom/generated/cmd/sandbox_operators_get_signup_token.go +++ b/soracom/generated/cmd/sandbox_operators_get_signup_token.go @@ -30,7 +30,7 @@ func InitSandboxOperatorsGetSignupTokenCmd() { SandboxOperatorsGetSignupTokenCmd.Flags().StringVar(&SandboxOperatorsGetSignupTokenCmdAuthKeyId, "auth-key-id", "", TRAPI("")) - SandboxOperatorsGetSignupTokenCmd.Flags().StringVar(&SandboxOperatorsGetSignupTokenCmdEmail, "email", "", TRAPI("email")) + SandboxOperatorsGetSignupTokenCmd.Flags().StringVar(&SandboxOperatorsGetSignupTokenCmdEmail, "email", "", TRAPI("Email")) SandboxOperatorsGetSignupTokenCmd.Flags().StringVar(&SandboxOperatorsGetSignupTokenCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) @@ -43,7 +43,7 @@ func InitSandboxOperatorsGetSignupTokenCmd() { var SandboxOperatorsGetSignupTokenCmd = &cobra.Command{ Use: "get-signup-token", Short: TRAPI("/sandbox/operators/token/{email}:post:summary"), - Long: TRAPI(`/sandbox/operators/token/{email}:post:description`) + "\n\n" + createLinkToAPIReference("Operator", "sandboxGetSignupToken"), + Long: TRAPI(`/sandbox/operators/token/{email}:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Operator", "sandboxGetSignupToken"), } func SandboxOperatorsGetSignupTokenCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_orders_ship.go b/soracom/generated/cmd/sandbox_orders_ship.go index a24a0ba9..8f16129b 100644 --- a/soracom/generated/cmd/sandbox_orders_ship.go +++ b/soracom/generated/cmd/sandbox_orders_ship.go @@ -38,7 +38,7 @@ func InitSandboxOrdersShipCmd() { var SandboxOrdersShipCmd = &cobra.Command{ Use: "ship", Short: TRAPI("/sandbox/orders/ship:post:summary"), - Long: TRAPI(`/sandbox/orders/ship:post:description`) + "\n\n" + createLinkToAPIReference("Order", "sandboxShipOrder"), + Long: TRAPI(`/sandbox/orders/ship:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Order", "sandboxShipOrder"), } func SandboxOrdersShipCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_stats_air_insert.go b/soracom/generated/cmd/sandbox_stats_air_insert.go index 8b01a7d4..a4ff3510 100644 --- a/soracom/generated/cmd/sandbox_stats_air_insert.go +++ b/soracom/generated/cmd/sandbox_stats_air_insert.go @@ -23,9 +23,9 @@ var SandboxStatsAirInsertCmdUnixtime int64 var SandboxStatsAirInsertCmdBody string func InitSandboxStatsAirInsertCmd() { - SandboxStatsAirInsertCmd.Flags().StringVar(&SandboxStatsAirInsertCmdImsi, "imsi", "", TRAPI("IMSI")) + SandboxStatsAirInsertCmd.Flags().StringVar(&SandboxStatsAirInsertCmdImsi, "imsi", "", TRAPI("IMSI.")) - SandboxStatsAirInsertCmd.Flags().Int64Var(&SandboxStatsAirInsertCmdUnixtime, "unixtime", 0, TRAPI("UNIX time (in milliseconds)")) + SandboxStatsAirInsertCmd.Flags().Int64Var(&SandboxStatsAirInsertCmdUnixtime, "unixtime", 0, TRAPI("UNIX time (in seconds).")) SandboxStatsAirInsertCmd.Flags().StringVar(&SandboxStatsAirInsertCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) @@ -38,7 +38,7 @@ func InitSandboxStatsAirInsertCmd() { var SandboxStatsAirInsertCmd = &cobra.Command{ Use: "insert", Short: TRAPI("/sandbox/stats/air/subscribers/{imsi}:post:summary"), - Long: TRAPI(`/sandbox/stats/air/subscribers/{imsi}:post:description`) + "\n\n" + createLinkToAPIReference("Stats", "sandboxInsertAirStats"), + Long: TRAPI(`/sandbox/stats/air/subscribers/{imsi}:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Stats", "sandboxInsertAirStats"), } func SandboxStatsAirInsertCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_stats_beam_insert.go b/soracom/generated/cmd/sandbox_stats_beam_insert.go index bc8b3517..55e36bdc 100644 --- a/soracom/generated/cmd/sandbox_stats_beam_insert.go +++ b/soracom/generated/cmd/sandbox_stats_beam_insert.go @@ -23,9 +23,9 @@ var SandboxStatsBeamInsertCmdUnixtime int64 var SandboxStatsBeamInsertCmdBody string func InitSandboxStatsBeamInsertCmd() { - SandboxStatsBeamInsertCmd.Flags().StringVar(&SandboxStatsBeamInsertCmdImsi, "imsi", "", TRAPI("IMSI")) + SandboxStatsBeamInsertCmd.Flags().StringVar(&SandboxStatsBeamInsertCmdImsi, "imsi", "", TRAPI("IMSI.")) - SandboxStatsBeamInsertCmd.Flags().Int64Var(&SandboxStatsBeamInsertCmdUnixtime, "unixtime", 0, TRAPI("UNIX time (in milliseconds)")) + SandboxStatsBeamInsertCmd.Flags().Int64Var(&SandboxStatsBeamInsertCmdUnixtime, "unixtime", 0, TRAPI("UNIX time (in seconds).")) SandboxStatsBeamInsertCmd.Flags().StringVar(&SandboxStatsBeamInsertCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) @@ -38,7 +38,7 @@ func InitSandboxStatsBeamInsertCmd() { var SandboxStatsBeamInsertCmd = &cobra.Command{ Use: "insert", Short: TRAPI("/sandbox/stats/beam/subscribers/{imsi}:post:summary"), - Long: TRAPI(`/sandbox/stats/beam/subscribers/{imsi}:post:description`) + "\n\n" + createLinkToAPIReference("Stats", "sandboxInsertBeamStats"), + Long: TRAPI(`/sandbox/stats/beam/subscribers/{imsi}:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Stats", "sandboxInsertBeamStats"), } func SandboxStatsBeamInsertCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/sandbox_subscribers_create.go b/soracom/generated/cmd/sandbox_subscribers_create.go index af0a4162..b3a7fa10 100644 --- a/soracom/generated/cmd/sandbox_subscribers_create.go +++ b/soracom/generated/cmd/sandbox_subscribers_create.go @@ -38,7 +38,7 @@ func InitSandboxSubscribersCreateCmd() { var SandboxSubscribersCreateCmd = &cobra.Command{ Use: "create", Short: TRAPI("/sandbox/subscribers/create:post:summary"), - Long: TRAPI(`/sandbox/subscribers/create:post:description`) + "\n\n" + createLinkToAPIReference("Subscriber", "sandboxCreateSubscriber"), + Long: TRAPI(`/sandbox/subscribers/create:post:description`) + "\n\n" + createLinkToAPIReference("API Sandbox: Subscriber", "sandboxCreateSubscriber"), } func SandboxSubscribersCreateCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/shipping_addresses_create.go b/soracom/generated/cmd/shipping_addresses_create.go index 313db3dd..47203ef4 100644 --- a/soracom/generated/cmd/shipping_addresses_create.go +++ b/soracom/generated/cmd/shipping_addresses_create.go @@ -74,7 +74,7 @@ func InitShippingAddressesCreateCmd() { ShippingAddressesCreateCmd.Flags().StringVar(&ShippingAddressesCreateCmdFullName, "full-name", "", TRAPI("")) - ShippingAddressesCreateCmd.Flags().StringVar(&ShippingAddressesCreateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + ShippingAddressesCreateCmd.Flags().StringVar(&ShippingAddressesCreateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) ShippingAddressesCreateCmd.Flags().StringVar(&ShippingAddressesCreateCmdPhoneNumber, "phone-number", "", TRAPI("")) diff --git a/soracom/generated/cmd/shipping_addresses_delete.go b/soracom/generated/cmd/shipping_addresses_delete.go index a3512cf9..e41a17cb 100644 --- a/soracom/generated/cmd/shipping_addresses_delete.go +++ b/soracom/generated/cmd/shipping_addresses_delete.go @@ -16,9 +16,9 @@ var ShippingAddressesDeleteCmdOperatorId string var ShippingAddressesDeleteCmdShippingAddressId string func InitShippingAddressesDeleteCmd() { - ShippingAddressesDeleteCmd.Flags().StringVar(&ShippingAddressesDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + ShippingAddressesDeleteCmd.Flags().StringVar(&ShippingAddressesDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - ShippingAddressesDeleteCmd.Flags().StringVar(&ShippingAddressesDeleteCmdShippingAddressId, "shipping-address-id", "", TRAPI("shipping_address_id")) + ShippingAddressesDeleteCmd.Flags().StringVar(&ShippingAddressesDeleteCmdShippingAddressId, "shipping-address-id", "", TRAPI("Shipping address ID.")) ShippingAddressesDeleteCmd.RunE = ShippingAddressesDeleteCmdRunE diff --git a/soracom/generated/cmd/shipping_addresses_get.go b/soracom/generated/cmd/shipping_addresses_get.go index ee5575a7..52039fe7 100644 --- a/soracom/generated/cmd/shipping_addresses_get.go +++ b/soracom/generated/cmd/shipping_addresses_get.go @@ -16,9 +16,9 @@ var ShippingAddressesGetCmdOperatorId string var ShippingAddressesGetCmdShippingAddressId string func InitShippingAddressesGetCmd() { - ShippingAddressesGetCmd.Flags().StringVar(&ShippingAddressesGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + ShippingAddressesGetCmd.Flags().StringVar(&ShippingAddressesGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - ShippingAddressesGetCmd.Flags().StringVar(&ShippingAddressesGetCmdShippingAddressId, "shipping-address-id", "", TRAPI("shipping_address_id")) + ShippingAddressesGetCmd.Flags().StringVar(&ShippingAddressesGetCmdShippingAddressId, "shipping-address-id", "", TRAPI("Shipping address ID.")) ShippingAddressesGetCmd.RunE = ShippingAddressesGetCmdRunE diff --git a/soracom/generated/cmd/shipping_addresses_list.go b/soracom/generated/cmd/shipping_addresses_list.go index d5c9b4d1..278d6f26 100644 --- a/soracom/generated/cmd/shipping_addresses_list.go +++ b/soracom/generated/cmd/shipping_addresses_list.go @@ -13,7 +13,7 @@ import ( var ShippingAddressesListCmdOperatorId string func InitShippingAddressesListCmd() { - ShippingAddressesListCmd.Flags().StringVar(&ShippingAddressesListCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + ShippingAddressesListCmd.Flags().StringVar(&ShippingAddressesListCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) ShippingAddressesListCmd.RunE = ShippingAddressesListCmdRunE diff --git a/soracom/generated/cmd/shipping_addresses_update.go b/soracom/generated/cmd/shipping_addresses_update.go index a74a490a..d9b05eb7 100644 --- a/soracom/generated/cmd/shipping_addresses_update.go +++ b/soracom/generated/cmd/shipping_addresses_update.go @@ -77,11 +77,11 @@ func InitShippingAddressesUpdateCmd() { ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdFullName, "full-name", "", TRAPI("")) - ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdPhoneNumber, "phone-number", "", TRAPI("")) - ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdShippingAddressId, "shipping-address-id", "", TRAPI("shipping_address_id")) + ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdShippingAddressId, "shipping-address-id", "", TRAPI("Shipping address ID.")) ShippingAddressesUpdateCmd.Flags().StringVar(&ShippingAddressesUpdateCmdState, "state", "", TRAPI("")) diff --git a/soracom/generated/cmd/sigfox_devices_get_data.go b/soracom/generated/cmd/sigfox_devices_get_data.go index e7f6b332..0db9767d 100644 --- a/soracom/generated/cmd/sigfox_devices_get_data.go +++ b/soracom/generated/cmd/sigfox_devices_get_data.go @@ -42,7 +42,7 @@ func InitSigfoxDevicesGetDataCmd() { SigfoxDevicesGetDataCmd.Flags().Int64Var(&SigfoxDevicesGetDataCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - SigfoxDevicesGetDataCmd.Flags().Int64Var(&SigfoxDevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve.")) + SigfoxDevicesGetDataCmd.Flags().Int64Var(&SigfoxDevicesGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) SigfoxDevicesGetDataCmd.Flags().Int64Var(&SigfoxDevicesGetDataCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/sims_create_packet_capture_session.go b/soracom/generated/cmd/sims_create_packet_capture_session.go index ca031035..4d39d0ef 100644 --- a/soracom/generated/cmd/sims_create_packet_capture_session.go +++ b/soracom/generated/cmd/sims_create_packet_capture_session.go @@ -28,7 +28,7 @@ var SimsCreatePacketCaptureSessionCmdBody string func InitSimsCreatePacketCaptureSessionCmd() { SimsCreatePacketCaptureSessionCmd.Flags().StringVar(&SimsCreatePacketCaptureSessionCmdPrefix, "prefix", "", TRAPI("")) - SimsCreatePacketCaptureSessionCmd.Flags().StringVar(&SimsCreatePacketCaptureSessionCmdSimId, "sim-id", "", TRAPI("The SIM ID for which a packet capture session is created")) + SimsCreatePacketCaptureSessionCmd.Flags().StringVar(&SimsCreatePacketCaptureSessionCmdSimId, "sim-id", "", TRAPI("SIM ID of the target SIM.")) SimsCreatePacketCaptureSessionCmd.Flags().Int64Var(&SimsCreatePacketCaptureSessionCmdDuration, "duration", 0, TRAPI("")) diff --git a/soracom/generated/cmd/sims_get_data.go b/soracom/generated/cmd/sims_get_data.go index 34f0cde4..9b90664d 100644 --- a/soracom/generated/cmd/sims_get_data.go +++ b/soracom/generated/cmd/sims_get_data.go @@ -42,7 +42,7 @@ func InitSimsGetDataCmd() { SimsGetDataCmd.Flags().Int64Var(&SimsGetDataCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - SimsGetDataCmd.Flags().Int64Var(&SimsGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve. The default is '10'.")) + SimsGetDataCmd.Flags().Int64Var(&SimsGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) SimsGetDataCmd.Flags().Int64Var(&SimsGetDataCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/sims_list_status_history.go b/soracom/generated/cmd/sims_list_status_history.go new file mode 100644 index 00000000..7e96b069 --- /dev/null +++ b/soracom/generated/cmd/sims_list_status_history.go @@ -0,0 +1,168 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SimsListStatusHistoryCmdLastEvaluatedKey holds value of 'last_evaluated_key' option +var SimsListStatusHistoryCmdLastEvaluatedKey string + +// SimsListStatusHistoryCmdSimId holds value of 'sim_id' option +var SimsListStatusHistoryCmdSimId string + +// SimsListStatusHistoryCmdSort holds value of 'sort' option +var SimsListStatusHistoryCmdSort string + +// SimsListStatusHistoryCmdFrom holds value of 'from' option +var SimsListStatusHistoryCmdFrom int64 + +// SimsListStatusHistoryCmdLimit holds value of 'limit' option +var SimsListStatusHistoryCmdLimit int64 + +// SimsListStatusHistoryCmdTo holds value of 'to' option +var SimsListStatusHistoryCmdTo int64 + +// SimsListStatusHistoryCmdPaginate indicates to do pagination or not +var SimsListStatusHistoryCmdPaginate bool + +// SimsListStatusHistoryCmdOutputJSONL indicates to output with jsonl format +var SimsListStatusHistoryCmdOutputJSONL bool + +func InitSimsListStatusHistoryCmd() { + SimsListStatusHistoryCmd.Flags().StringVar(&SimsListStatusHistoryCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("A string consisting of the primary IMSI and the timestamp (UNIX time in milliseconds) of the last status operation history entry obtained on the previous page, concatenated with '@'. By specifying this parameter, you can continue to retrieve the list from the next page onward.")) + + SimsListStatusHistoryCmd.Flags().StringVar(&SimsListStatusHistoryCmdSimId, "sim-id", "", TRAPI("SIM ID of the target SIM.")) + + SimsListStatusHistoryCmd.Flags().StringVar(&SimsListStatusHistoryCmdSort, "sort", "desc", TRAPI("Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first).")) + + SimsListStatusHistoryCmd.Flags().Int64Var(&SimsListStatusHistoryCmdFrom, "from", 0, TRAPI("Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, 'from' is set to the oldest status operation history entry time of the target IoT SIM.")) + + SimsListStatusHistoryCmd.Flags().Int64Var(&SimsListStatusHistoryCmdLimit, "limit", 30, TRAPI("Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit.")) + + SimsListStatusHistoryCmd.Flags().Int64Var(&SimsListStatusHistoryCmdTo, "to", 0, TRAPI("End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, 'to' is set to the current time.")) + + SimsListStatusHistoryCmd.Flags().BoolVar(&SimsListStatusHistoryCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) + + SimsListStatusHistoryCmd.Flags().BoolVar(&SimsListStatusHistoryCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) + + SimsListStatusHistoryCmd.RunE = SimsListStatusHistoryCmdRunE + + SimsCmd.AddCommand(SimsListStatusHistoryCmd) +} + +// SimsListStatusHistoryCmd defines 'list-status-history' subcommand +var SimsListStatusHistoryCmd = &cobra.Command{ + Use: "list-status-history", + Short: TRAPI("/sims/{sim_id}/statuses/history:get:summary"), + Long: TRAPI(`/sims/{sim_id}/statuses/history:get:description`) + "\n\n" + createLinkToAPIReference("Sim", "listSimStatusHistory"), +} + +func SimsListStatusHistoryCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSimsListStatusHistoryCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + if SimsListStatusHistoryCmdOutputJSONL { + return printStringAsJSONL(body) + } + + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSimsListStatusHistoryCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + + err = checkIfRequiredStringParameterIsSupplied("sim_id", "sim-id", "path", parsedBody, SimsListStatusHistoryCmdSimId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSimsListStatusHistoryCmd("/sims/{sim_id}/statuses/history"), + query: buildQueryForSimsListStatusHistoryCmd(), + + doPagination: SimsListStatusHistoryCmdPaginate, + paginationKeyHeaderInResponse: "x-soracom-next-key", + paginationRequestParameterInQuery: "last_evaluated_key", + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSimsListStatusHistoryCmd(path string) string { + + escapedSimId := url.PathEscape(SimsListStatusHistoryCmdSimId) + + path = strReplace(path, "{"+"sim_id"+"}", escapedSimId, -1) + + return path +} + +func buildQueryForSimsListStatusHistoryCmd() url.Values { + result := url.Values{} + + if SimsListStatusHistoryCmdLastEvaluatedKey != "" { + result.Add("last_evaluated_key", SimsListStatusHistoryCmdLastEvaluatedKey) + } + + if SimsListStatusHistoryCmdSort != "desc" { + result.Add("sort", SimsListStatusHistoryCmdSort) + } + + if SimsListStatusHistoryCmdFrom != 0 { + result.Add("from", sprintf("%d", SimsListStatusHistoryCmdFrom)) + } + + if SimsListStatusHistoryCmdLimit != 30 { + result.Add("limit", sprintf("%d", SimsListStatusHistoryCmdLimit)) + } + + if SimsListStatusHistoryCmdTo != 0 { + result.Add("to", sprintf("%d", SimsListStatusHistoryCmdTo)) + } + + return result +} diff --git a/soracom/generated/cmd/sims_set_imei_lock.go b/soracom/generated/cmd/sims_set_imei_lock.go index b84e8f48..bca2d1f5 100644 --- a/soracom/generated/cmd/sims_set_imei_lock.go +++ b/soracom/generated/cmd/sims_set_imei_lock.go @@ -23,7 +23,7 @@ var SimsSetImeiLockCmdSimId string var SimsSetImeiLockCmdBody string func InitSimsSetImeiLockCmd() { - SimsSetImeiLockCmd.Flags().StringVar(&SimsSetImeiLockCmdImei, "imei", "", TRAPI("")) + SimsSetImeiLockCmd.Flags().StringVar(&SimsSetImeiLockCmdImei, "imei", "", TRAPI("IMEI of the target device. If you want to establish a session even when the IMEI is temporarily not reported, append '|ANONYMOUS' to the IMEI value.For example, if the IMEI specified is '123456789012345', specifying '123456789012345|ANONYMOUS' as the parameter value will allow a session to be established even when the IMEI is temporarily not reported.")) SimsSetImeiLockCmd.Flags().StringVar(&SimsSetImeiLockCmdSimId, "sim-id", "", TRAPI("SIM ID of the target SIM.")) diff --git a/soracom/generated/cmd/sims_update_speed_class.go b/soracom/generated/cmd/sims_update_speed_class.go index ceba8bb4..126f49f5 100644 --- a/soracom/generated/cmd/sims_update_speed_class.go +++ b/soracom/generated/cmd/sims_update_speed_class.go @@ -25,7 +25,7 @@ var SimsUpdateSpeedClassCmdBody string func InitSimsUpdateSpeedClassCmd() { SimsUpdateSpeedClassCmd.Flags().StringVar(&SimsUpdateSpeedClassCmdSimId, "sim-id", "", TRAPI("SIM ID of the target SIM.")) - SimsUpdateSpeedClassCmd.Flags().StringVar(&SimsUpdateSpeedClassCmdSpeedClass, "speed-class", "", TRAPI("Speed class. Specify one of the following. Please specify the speed class that matches the subscription.- For plan01s, plan01s - Low Data Volume, planP1, planX3 X3-5MB, plan-D: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast'- For plan-KM1: - 't1.standard'- For plan-DU: - 'u1.standard' - 'u1.slow'- For virtual SIM/Subscriber: - 'arc.standard'")) + SimsUpdateSpeedClassCmd.Flags().StringVar(&SimsUpdateSpeedClassCmdSpeedClass, "speed-class", "", TRAPI("Speed class. Specify one of the following. Please specify the speed class that matches the subscription.- For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast'- For plan-US: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast' - 's1.8xfast'- For plan-DU: - 'u1.standard' - 'u1.slow'- For plan-KM1: - 't1.standard'- For virtual SIM/Subscriber: - 'arc.standard'")) SimsUpdateSpeedClassCmd.Flags().StringVar(&SimsUpdateSpeedClassCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam.go b/soracom/generated/cmd/sora_cam_devices_atomcam.go new file mode 100644 index 00000000..80c8c092 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam.go @@ -0,0 +1,17 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "github.com/spf13/cobra" +) + +func init() { + SoraCamDevicesCmd.AddCommand(SoraCamDevicesAtomcamCmd) +} + +// SoraCamDevicesAtomcamCmd defines 'atomcam' subcommand +var SoraCamDevicesAtomcamCmd = &cobra.Command{ + Use: "atomcam", + Short: TRCLI("cli.sora-cam.devices.atomcam.summary"), + Long: TRCLI(`cli.sora-cam.devices.atomcam.description`), +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_get_settings.go b/soracom/generated/cmd/sora_cam_devices_atomcam_get_settings.go new file mode 100644 index 00000000..1a33802e --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_get_settings.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamGetSettingsCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamGetSettingsCmdDeviceId string + +func InitSoraCamDevicesAtomcamGetSettingsCmd() { + SoraCamDevicesAtomcamGetSettingsCmd.Flags().StringVar(&SoraCamDevicesAtomcamGetSettingsCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamGetSettingsCmd.RunE = SoraCamDevicesAtomcamGetSettingsCmdRunE + + SoraCamDevicesAtomcamCmd.AddCommand(SoraCamDevicesAtomcamGetSettingsCmd) +} + +// SoraCamDevicesAtomcamGetSettingsCmd defines 'get-settings' subcommand +var SoraCamDevicesAtomcamGetSettingsCmd = &cobra.Command{ + Use: "get-settings", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettings"), +} + +func SoraCamDevicesAtomcamGetSettingsCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamGetSettingsCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamGetSettingsCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamGetSettingsCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamGetSettingsCmd("/sora_cam/devices/{device_id}/atomcam/settings"), + query: buildQueryForSoraCamDevicesAtomcamGetSettingsCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamGetSettingsCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamGetSettingsCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamGetSettingsCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings.go new file mode 100644 index 00000000..0bb61aa3 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings.go @@ -0,0 +1,17 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "github.com/spf13/cobra" +) + +func init() { + SoraCamDevicesAtomcamCmd.AddCommand(SoraCamDevicesAtomcamSettingsCmd) +} + +// SoraCamDevicesAtomcamSettingsCmd defines 'settings' subcommand +var SoraCamDevicesAtomcamSettingsCmd = &cobra.Command{ + Use: "settings", + Short: TRCLI("cli.sora-cam.devices.atomcam.settings.summary"), + Long: TRCLI(`cli.sora-cam.devices.atomcam.settings.description`), +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_logo.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_logo.go new file mode 100644 index 00000000..d305d0a2 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_logo.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetLogoCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetLogoCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetLogoCmd() { + SoraCamDevicesAtomcamSettingsGetLogoCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetLogoCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetLogoCmd.RunE = SoraCamDevicesAtomcamSettingsGetLogoCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetLogoCmd) +} + +// SoraCamDevicesAtomcamSettingsGetLogoCmd defines 'get-logo' subcommand +var SoraCamDevicesAtomcamSettingsGetLogoCmd = &cobra.Command{ + Use: "get-logo", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/logo:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/logo:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsLogo"), +} + +func SoraCamDevicesAtomcamSettingsGetLogoCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetLogoCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetLogoCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetLogoCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetLogoCmd("/sora_cam/devices/{device_id}/atomcam/settings/logo"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetLogoCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetLogoCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetLogoCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetLogoCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_motion_tagging.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_motion_tagging.go new file mode 100644 index 00000000..da41ab3f --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_motion_tagging.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd() { + SoraCamDevicesAtomcamSettingsGetMotionTaggingCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetMotionTaggingCmd.RunE = SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetMotionTaggingCmd) +} + +// SoraCamDevicesAtomcamSettingsGetMotionTaggingCmd defines 'get-motion-tagging' subcommand +var SoraCamDevicesAtomcamSettingsGetMotionTaggingCmd = &cobra.Command{ + Use: "get-motion-tagging", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsMotionTagging"), +} + +func SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetMotionTaggingCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetMotionTaggingCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd("/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetMotionTaggingCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetMotionTaggingCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_night_vision.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_night_vision.go new file mode 100644 index 00000000..c1fedf75 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_night_vision.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetNightVisionCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetNightVisionCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetNightVisionCmd() { + SoraCamDevicesAtomcamSettingsGetNightVisionCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetNightVisionCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetNightVisionCmd.RunE = SoraCamDevicesAtomcamSettingsGetNightVisionCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetNightVisionCmd) +} + +// SoraCamDevicesAtomcamSettingsGetNightVisionCmd defines 'get-night-vision' subcommand +var SoraCamDevicesAtomcamSettingsGetNightVisionCmd = &cobra.Command{ + Use: "get-night-vision", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/night_vision:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/night_vision:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsNightVision"), +} + +func SoraCamDevicesAtomcamSettingsGetNightVisionCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetNightVisionCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetNightVisionCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetNightVisionCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetNightVisionCmd("/sora_cam/devices/{device_id}/atomcam/settings/night_vision"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetNightVisionCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetNightVisionCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetNightVisionCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetNightVisionCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_quality.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_quality.go new file mode 100644 index 00000000..6f3dacad --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_quality.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetQualityCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetQualityCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetQualityCmd() { + SoraCamDevicesAtomcamSettingsGetQualityCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetQualityCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetQualityCmd.RunE = SoraCamDevicesAtomcamSettingsGetQualityCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetQualityCmd) +} + +// SoraCamDevicesAtomcamSettingsGetQualityCmd defines 'get-quality' subcommand +var SoraCamDevicesAtomcamSettingsGetQualityCmd = &cobra.Command{ + Use: "get-quality", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/quality:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/quality:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsQuality"), +} + +func SoraCamDevicesAtomcamSettingsGetQualityCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetQualityCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetQualityCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetQualityCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetQualityCmd("/sora_cam/devices/{device_id}/atomcam/settings/quality"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetQualityCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetQualityCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetQualityCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetQualityCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_rotation.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_rotation.go new file mode 100644 index 00000000..a639d13b --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_rotation.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetRotationCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetRotationCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetRotationCmd() { + SoraCamDevicesAtomcamSettingsGetRotationCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetRotationCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetRotationCmd.RunE = SoraCamDevicesAtomcamSettingsGetRotationCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetRotationCmd) +} + +// SoraCamDevicesAtomcamSettingsGetRotationCmd defines 'get-rotation' subcommand +var SoraCamDevicesAtomcamSettingsGetRotationCmd = &cobra.Command{ + Use: "get-rotation", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/rotation:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/rotation:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsRotation"), +} + +func SoraCamDevicesAtomcamSettingsGetRotationCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetRotationCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetRotationCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetRotationCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetRotationCmd("/sora_cam/devices/{device_id}/atomcam/settings/rotation"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetRotationCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetRotationCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetRotationCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetRotationCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_status_light.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_status_light.go new file mode 100644 index 00000000..00919c30 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_status_light.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetStatusLightCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetStatusLightCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetStatusLightCmd() { + SoraCamDevicesAtomcamSettingsGetStatusLightCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetStatusLightCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetStatusLightCmd.RunE = SoraCamDevicesAtomcamSettingsGetStatusLightCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetStatusLightCmd) +} + +// SoraCamDevicesAtomcamSettingsGetStatusLightCmd defines 'get-status-light' subcommand +var SoraCamDevicesAtomcamSettingsGetStatusLightCmd = &cobra.Command{ + Use: "get-status-light", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/status_light:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/status_light:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsStatusLight"), +} + +func SoraCamDevicesAtomcamSettingsGetStatusLightCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetStatusLightCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetStatusLightCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetStatusLightCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetStatusLightCmd("/sora_cam/devices/{device_id}/atomcam/settings/status_light"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetStatusLightCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetStatusLightCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetStatusLightCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetStatusLightCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_timestamp.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_timestamp.go new file mode 100644 index 00000000..dfdd4775 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_get_timestamp.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsGetTimestampCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsGetTimestampCmdDeviceId string + +func InitSoraCamDevicesAtomcamSettingsGetTimestampCmd() { + SoraCamDevicesAtomcamSettingsGetTimestampCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsGetTimestampCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsGetTimestampCmd.RunE = SoraCamDevicesAtomcamSettingsGetTimestampCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsGetTimestampCmd) +} + +// SoraCamDevicesAtomcamSettingsGetTimestampCmd defines 'get-timestamp' subcommand +var SoraCamDevicesAtomcamSettingsGetTimestampCmd = &cobra.Command{ + Use: "get-timestamp", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/timestamp:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/timestamp:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceAtomCamSettingsTimestamp"), +} + +func SoraCamDevicesAtomcamSettingsGetTimestampCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsGetTimestampCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsGetTimestampCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsGetTimestampCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesAtomcamSettingsGetTimestampCmd("/sora_cam/devices/{device_id}/atomcam/settings/timestamp"), + query: buildQueryForSoraCamDevicesAtomcamSettingsGetTimestampCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsGetTimestampCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsGetTimestampCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsGetTimestampCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_logo.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_logo.go new file mode 100644 index 00000000..250331c5 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_logo.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetLogoCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetLogoCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetLogoCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetLogoCmdState string + +// SoraCamDevicesAtomcamSettingsSetLogoCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetLogoCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetLogoCmd() { + SoraCamDevicesAtomcamSettingsSetLogoCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetLogoCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetLogoCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetLogoCmdState, "state", "", TRAPI("Display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image.- 'on'- 'off'")) + + SoraCamDevicesAtomcamSettingsSetLogoCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetLogoCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetLogoCmd.RunE = SoraCamDevicesAtomcamSettingsSetLogoCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetLogoCmd) +} + +// SoraCamDevicesAtomcamSettingsSetLogoCmd defines 'set-logo' subcommand +var SoraCamDevicesAtomcamSettingsSetLogoCmd = &cobra.Command{ + Use: "set-logo", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/logo:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/logo:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsLogo"), +} + +func SoraCamDevicesAtomcamSettingsSetLogoCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetLogoCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetLogoCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetLogoCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetLogoCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetLogoCmd("/sora_cam/devices/{device_id}/atomcam/settings/logo"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetLogoCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetLogoCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetLogoCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetLogoCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetLogoCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetLogoCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetLogoCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetLogoCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetLogoCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetLogoCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetLogoCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetLogoCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_motion_tagging.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_motion_tagging.go new file mode 100644 index 00000000..ded360fe --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_motion_tagging.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdState string + +// SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd() { + SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdState, "state", "", TRAPI("Display settings for motion tagging.- 'on'- 'off'")) + + SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd.RunE = SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd) +} + +// SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd defines 'set-motion-tagging' subcommand +var SoraCamDevicesAtomcamSettingsSetMotionTaggingCmd = &cobra.Command{ + Use: "set-motion-tagging", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsMotionTagging"), +} + +func SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetMotionTaggingCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetMotionTaggingCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd("/sora_cam/devices/{device_id}/atomcam/settings/motion_tagging"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetMotionTaggingCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetMotionTaggingCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_night_vision.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_night_vision.go new file mode 100644 index 00000000..858dd188 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_night_vision.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetNightVisionCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetNightVisionCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetNightVisionCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetNightVisionCmdState string + +// SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetNightVisionCmd() { + SoraCamDevicesAtomcamSettingsSetNightVisionCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetNightVisionCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetNightVisionCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetNightVisionCmdState, "state", "", TRAPI("Settings for night vision mode.- 'on': Night vision mode.- 'off': Normal mode.- 'auto': Auto-switching.")) + + SoraCamDevicesAtomcamSettingsSetNightVisionCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetNightVisionCmd.RunE = SoraCamDevicesAtomcamSettingsSetNightVisionCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetNightVisionCmd) +} + +// SoraCamDevicesAtomcamSettingsSetNightVisionCmd defines 'set-night-vision' subcommand +var SoraCamDevicesAtomcamSettingsSetNightVisionCmd = &cobra.Command{ + Use: "set-night-vision", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/night_vision:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/night_vision:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsNightVision"), +} + +func SoraCamDevicesAtomcamSettingsSetNightVisionCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetNightVisionCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetNightVisionCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetNightVisionCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetNightVisionCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetNightVisionCmd("/sora_cam/devices/{device_id}/atomcam/settings/night_vision"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetNightVisionCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetNightVisionCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetNightVisionCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetNightVisionCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetNightVisionCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetNightVisionCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetNightVisionCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetNightVisionCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_quality.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_quality.go new file mode 100644 index 00000000..44df3e72 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_quality.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetQualityCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetQualityCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetQualityCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetQualityCmdState string + +// SoraCamDevicesAtomcamSettingsSetQualityCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetQualityCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetQualityCmd() { + SoraCamDevicesAtomcamSettingsSetQualityCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetQualityCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetQualityCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetQualityCmdState, "state", "", TRAPI("Settings for the live video and cloud recording quality. Note that for cloud recordings, the resolution is 1080p (1920 x 1080 pixels), regardless of the quality setting.- 'low': The same quality as selecting \"360p\" in the ATOM app.- 'medium': The same quality as selecting \"SD\" in the ATOM app.- 'high': The same quality as selecting \"HD (1080p)\" in the ATOM app.")) + + SoraCamDevicesAtomcamSettingsSetQualityCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetQualityCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetQualityCmd.RunE = SoraCamDevicesAtomcamSettingsSetQualityCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetQualityCmd) +} + +// SoraCamDevicesAtomcamSettingsSetQualityCmd defines 'set-quality' subcommand +var SoraCamDevicesAtomcamSettingsSetQualityCmd = &cobra.Command{ + Use: "set-quality", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/quality:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/quality:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsQuality"), +} + +func SoraCamDevicesAtomcamSettingsSetQualityCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetQualityCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetQualityCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetQualityCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetQualityCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetQualityCmd("/sora_cam/devices/{device_id}/atomcam/settings/quality"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetQualityCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetQualityCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetQualityCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetQualityCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetQualityCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetQualityCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetQualityCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetQualityCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetQualityCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetQualityCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetQualityCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetQualityCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_rotation.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_rotation.go new file mode 100644 index 00000000..7424625f --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_rotation.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetRotationCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetRotationCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetRotationCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetRotationCmdState int64 + +// SoraCamDevicesAtomcamSettingsSetRotationCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetRotationCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetRotationCmd() { + SoraCamDevicesAtomcamSettingsSetRotationCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetRotationCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetRotationCmd.Flags().Int64Var(&SoraCamDevicesAtomcamSettingsSetRotationCmdState, "state", 0, TRAPI("Settings for rotating the image by 180 degrees. Set to '180' when installing the compatible camera device upside down.- '0': OFF (no rotation).- '180': ON (180-degree rotation).")) + + SoraCamDevicesAtomcamSettingsSetRotationCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetRotationCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetRotationCmd.RunE = SoraCamDevicesAtomcamSettingsSetRotationCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetRotationCmd) +} + +// SoraCamDevicesAtomcamSettingsSetRotationCmd defines 'set-rotation' subcommand +var SoraCamDevicesAtomcamSettingsSetRotationCmd = &cobra.Command{ + Use: "set-rotation", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/rotation:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/rotation:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsRotation"), +} + +func SoraCamDevicesAtomcamSettingsSetRotationCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetRotationCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetRotationCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetRotationCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetRotationCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetRotationCmd("/sora_cam/devices/{device_id}/atomcam/settings/rotation"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetRotationCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetRotationCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetRotationCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetRotationCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetRotationCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetRotationCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetRotationCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetRotationCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetRotationCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetRotationCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetRotationCmd.Flags().Lookup("state").Changed { + result["state"] = SoraCamDevicesAtomcamSettingsSetRotationCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_status_light.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_status_light.go new file mode 100644 index 00000000..682661d6 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_status_light.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetStatusLightCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetStatusLightCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetStatusLightCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetStatusLightCmdState string + +// SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetStatusLightCmd() { + SoraCamDevicesAtomcamSettingsSetStatusLightCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetStatusLightCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetStatusLightCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetStatusLightCmdState, "state", "", TRAPI("Settings for the status light (indicator light that shows the status of the camera).- 'on'- 'off'")) + + SoraCamDevicesAtomcamSettingsSetStatusLightCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetStatusLightCmd.RunE = SoraCamDevicesAtomcamSettingsSetStatusLightCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetStatusLightCmd) +} + +// SoraCamDevicesAtomcamSettingsSetStatusLightCmd defines 'set-status-light' subcommand +var SoraCamDevicesAtomcamSettingsSetStatusLightCmd = &cobra.Command{ + Use: "set-status-light", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/status_light:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/status_light:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsStatusLight"), +} + +func SoraCamDevicesAtomcamSettingsSetStatusLightCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetStatusLightCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetStatusLightCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetStatusLightCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetStatusLightCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetStatusLightCmd("/sora_cam/devices/{device_id}/atomcam/settings/status_light"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetStatusLightCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetStatusLightCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetStatusLightCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetStatusLightCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetStatusLightCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetStatusLightCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetStatusLightCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetStatusLightCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_timestamp.go b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_timestamp.go new file mode 100644 index 00000000..097a7d10 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_atomcam_settings_set_timestamp.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesAtomcamSettingsSetTimestampCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesAtomcamSettingsSetTimestampCmdDeviceId string + +// SoraCamDevicesAtomcamSettingsSetTimestampCmdState holds value of 'state' option +var SoraCamDevicesAtomcamSettingsSetTimestampCmdState string + +// SoraCamDevicesAtomcamSettingsSetTimestampCmdBody holds contents of request body to be sent +var SoraCamDevicesAtomcamSettingsSetTimestampCmdBody string + +func InitSoraCamDevicesAtomcamSettingsSetTimestampCmd() { + SoraCamDevicesAtomcamSettingsSetTimestampCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetTimestampCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesAtomcamSettingsSetTimestampCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetTimestampCmdState, "state", "", TRAPI("Display settings for the timestamp shown on the bottom right of the captured image.- 'on'- 'off'")) + + SoraCamDevicesAtomcamSettingsSetTimestampCmd.Flags().StringVar(&SoraCamDevicesAtomcamSettingsSetTimestampCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesAtomcamSettingsSetTimestampCmd.RunE = SoraCamDevicesAtomcamSettingsSetTimestampCmdRunE + + SoraCamDevicesAtomcamSettingsCmd.AddCommand(SoraCamDevicesAtomcamSettingsSetTimestampCmd) +} + +// SoraCamDevicesAtomcamSettingsSetTimestampCmd defines 'set-timestamp' subcommand +var SoraCamDevicesAtomcamSettingsSetTimestampCmd = &cobra.Command{ + Use: "set-timestamp", + Short: TRAPI("/sora_cam/devices/{device_id}/atomcam/settings/timestamp:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/atomcam/settings/timestamp:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceAtomCamSettingsTimestamp"), +} + +func SoraCamDevicesAtomcamSettingsSetTimestampCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesAtomcamSettingsSetTimestampCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesAtomcamSettingsSetTimestampCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesAtomcamSettingsSetTimestampCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesAtomcamSettingsSetTimestampCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesAtomcamSettingsSetTimestampCmd("/sora_cam/devices/{device_id}/atomcam/settings/timestamp"), + query: buildQueryForSoraCamDevicesAtomcamSettingsSetTimestampCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesAtomcamSettingsSetTimestampCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesAtomcamSettingsSetTimestampCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesAtomcamSettingsSetTimestampCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesAtomcamSettingsSetTimestampCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesAtomcamSettingsSetTimestampCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesAtomcamSettingsSetTimestampCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesAtomcamSettingsSetTimestampCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesAtomcamSettingsSetTimestampCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesAtomcamSettingsSetTimestampCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesAtomcamSettingsSetTimestampCmdState != "" { + result["state"] = SoraCamDevicesAtomcamSettingsSetTimestampCmdState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_events_list_for_device.go b/soracom/generated/cmd/sora_cam_devices_events_list_for_device.go index b9c2de7c..f37dc2f8 100644 --- a/soracom/generated/cmd/sora_cam_devices_events_list_for_device.go +++ b/soracom/generated/cmd/sora_cam_devices_events_list_for_device.go @@ -34,7 +34,7 @@ var SoraCamDevicesEventsListForDeviceCmdPaginate bool var SoraCamDevicesEventsListForDeviceCmdOutputJSONL bool func InitSoraCamDevicesEventsListForDeviceCmd() { - SoraCamDevicesEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesEventsListForDeviceCmdDeviceId, "device-id", "", TRAPI("ID of the target SoraCam device.")) + SoraCamDevicesEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesEventsListForDeviceCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) SoraCamDevicesEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesEventsListForDeviceCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("Value of the x-soracom-next-key header in the response to the last listSoraCamDeviceEventsForDevice request. By specifying this parameter, you can continue to retrieve the list from the last request.")) diff --git a/soracom/generated/cmd/sora_cam_devices_get_name.go b/soracom/generated/cmd/sora_cam_devices_get_name.go new file mode 100644 index 00000000..f111a86b --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_get_name.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesGetNameCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesGetNameCmdDeviceId string + +func InitSoraCamDevicesGetNameCmd() { + SoraCamDevicesGetNameCmd.Flags().StringVar(&SoraCamDevicesGetNameCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesGetNameCmd.RunE = SoraCamDevicesGetNameCmdRunE + + SoraCamDevicesCmd.AddCommand(SoraCamDevicesGetNameCmd) +} + +// SoraCamDevicesGetNameCmd defines 'get-name' subcommand +var SoraCamDevicesGetNameCmd = &cobra.Command{ + Use: "get-name", + Short: TRAPI("/sora_cam/devices/{device_id}/name:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/name:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDeviceName"), +} + +func SoraCamDevicesGetNameCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesGetNameCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesGetNameCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesGetNameCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesGetNameCmd("/sora_cam/devices/{device_id}/name"), + query: buildQueryForSoraCamDevicesGetNameCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesGetNameCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesGetNameCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesGetNameCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_get_power_state.go b/soracom/generated/cmd/sora_cam_devices_get_power_state.go new file mode 100644 index 00000000..e3067d37 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_get_power_state.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesGetPowerStateCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesGetPowerStateCmdDeviceId string + +func InitSoraCamDevicesGetPowerStateCmd() { + SoraCamDevicesGetPowerStateCmd.Flags().StringVar(&SoraCamDevicesGetPowerStateCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesGetPowerStateCmd.RunE = SoraCamDevicesGetPowerStateCmdRunE + + SoraCamDevicesCmd.AddCommand(SoraCamDevicesGetPowerStateCmd) +} + +// SoraCamDevicesGetPowerStateCmd defines 'get-power-state' subcommand +var SoraCamDevicesGetPowerStateCmd = &cobra.Command{ + Use: "get-power-state", + Short: TRAPI("/sora_cam/devices/{device_id}/power_state:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/power_state:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "getSoraCamDevicePowerState"), +} + +func SoraCamDevicesGetPowerStateCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesGetPowerStateCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesGetPowerStateCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesGetPowerStateCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesGetPowerStateCmd("/sora_cam/devices/{device_id}/power_state"), + query: buildQueryForSoraCamDevicesGetPowerStateCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesGetPowerStateCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesGetPowerStateCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesGetPowerStateCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_reboot.go b/soracom/generated/cmd/sora_cam_devices_reboot.go new file mode 100644 index 00000000..e88ba7eb --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_reboot.go @@ -0,0 +1,104 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesRebootCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesRebootCmdDeviceId string + +func InitSoraCamDevicesRebootCmd() { + SoraCamDevicesRebootCmd.Flags().StringVar(&SoraCamDevicesRebootCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesRebootCmd.RunE = SoraCamDevicesRebootCmdRunE + + SoraCamDevicesCmd.AddCommand(SoraCamDevicesRebootCmd) +} + +// SoraCamDevicesRebootCmd defines 'reboot' subcommand +var SoraCamDevicesRebootCmd = &cobra.Command{ + Use: "reboot", + Short: TRAPI("/sora_cam/devices/{device_id}/reboot:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/reboot:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "rebootSoraCamDevice"), +} + +func SoraCamDevicesRebootCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesRebootCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesRebootCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesRebootCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesRebootCmd("/sora_cam/devices/{device_id}/reboot"), + query: buildQueryForSoraCamDevicesRebootCmd(), + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesRebootCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesRebootCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesRebootCmd() url.Values { + result := url.Values{} + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_recordings_and_events.go b/soracom/generated/cmd/sora_cam_devices_recordings_and_events.go new file mode 100644 index 00000000..d2d22de8 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_recordings_and_events.go @@ -0,0 +1,17 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "github.com/spf13/cobra" +) + +func init() { + SoraCamDevicesCmd.AddCommand(SoraCamDevicesRecordingsAndEventsCmd) +} + +// SoraCamDevicesRecordingsAndEventsCmd defines 'recordings-and-events' subcommand +var SoraCamDevicesRecordingsAndEventsCmd = &cobra.Command{ + Use: "recordings-and-events", + Short: TRCLI("cli.sora-cam.devices.recordings-and-events.summary"), + Long: TRCLI(`cli.sora-cam.devices.recordings-and-events.description`), +} diff --git a/soracom/generated/cmd/sora_cam_devices_recordings_and_events_list_for_device.go b/soracom/generated/cmd/sora_cam_devices_recordings_and_events_list_for_device.go new file mode 100644 index 00000000..322aa588 --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_recordings_and_events_list_for_device.go @@ -0,0 +1,149 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "fmt" + "net/url" + "os" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdDeviceId string + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdLastEvaluatedKey holds value of 'last_evaluated_key' option +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdLastEvaluatedKey string + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdSort holds value of 'sort' option +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdSort string + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdFrom holds value of 'from' option +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdFrom int64 + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdTo holds value of 'to' option +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdTo int64 + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmdPaginate indicates to do pagination or not +var SoraCamDevicesRecordingsAndEventsListForDeviceCmdPaginate bool + +func InitSoraCamDevicesRecordingsAndEventsListForDeviceCmd() { + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdDeviceId, "device-id", "", TRAPI("Device ID of the compatible camera device.")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("Value of the x-soracom-next-key header in the response to the last listSoraCamDeviceRecordingsAndEvents request. By specifying this parameter, you can continue to retrieve the list from the last request.")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().StringVar(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdSort, "sort", "desc", TRAPI("Sort order of the recordings and events.- 'desc': Descending order (latest data entry first)- 'asc': Ascending order (oldest data entry first)")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().Int64Var(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdFrom, "from", 0, TRAPI("Start time of the list to be searched (unix time in milliseconds). If not specified, 'from' is set to the oldest time within the retention period of the license assigned to the compatible camera device.")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().Int64Var(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdTo, "to", 0, TRAPI("End time of the list to be searched (unix time in milliseconds). If not specified, 'to' is set to the current time.")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.Flags().BoolVar(&SoraCamDevicesRecordingsAndEventsListForDeviceCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) + + SoraCamDevicesRecordingsAndEventsListForDeviceCmd.RunE = SoraCamDevicesRecordingsAndEventsListForDeviceCmdRunE + + SoraCamDevicesRecordingsAndEventsCmd.AddCommand(SoraCamDevicesRecordingsAndEventsListForDeviceCmd) +} + +// SoraCamDevicesRecordingsAndEventsListForDeviceCmd defines 'list-for-device' subcommand +var SoraCamDevicesRecordingsAndEventsListForDeviceCmd = &cobra.Command{ + Use: "list-for-device", + Short: TRAPI("/sora_cam/devices/{device_id}/recordings_and_events:get:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/recordings_and_events:get:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "listSoraCamDeviceRecordingsAndEvents"), +} + +func SoraCamDevicesRecordingsAndEventsListForDeviceCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesRecordingsAndEventsListForDeviceCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesRecordingsAndEventsListForDeviceCmdParams(ac *apiClient) (*apiParams, error) { + var parsedBody interface{} + var err error + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesRecordingsAndEventsListForDeviceCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "GET", + path: buildPathForSoraCamDevicesRecordingsAndEventsListForDeviceCmd("/sora_cam/devices/{device_id}/recordings_and_events"), + query: buildQueryForSoraCamDevicesRecordingsAndEventsListForDeviceCmd(), + + doPagination: SoraCamDevicesRecordingsAndEventsListForDeviceCmdPaginate, + paginationKeyHeaderInResponse: "x-soracom-next-key", + paginationRequestParameterInQuery: "last_evaluated_key", + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesRecordingsAndEventsListForDeviceCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesRecordingsAndEventsListForDeviceCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesRecordingsAndEventsListForDeviceCmd() url.Values { + result := url.Values{} + + if SoraCamDevicesRecordingsAndEventsListForDeviceCmdLastEvaluatedKey != "" { + result.Add("last_evaluated_key", SoraCamDevicesRecordingsAndEventsListForDeviceCmdLastEvaluatedKey) + } + + if SoraCamDevicesRecordingsAndEventsListForDeviceCmdSort != "desc" { + result.Add("sort", SoraCamDevicesRecordingsAndEventsListForDeviceCmdSort) + } + + if SoraCamDevicesRecordingsAndEventsListForDeviceCmdFrom != 0 { + result.Add("from", sprintf("%d", SoraCamDevicesRecordingsAndEventsListForDeviceCmdFrom)) + } + + if SoraCamDevicesRecordingsAndEventsListForDeviceCmdTo != 0 { + result.Add("to", sprintf("%d", SoraCamDevicesRecordingsAndEventsListForDeviceCmdTo)) + } + + return result +} diff --git a/soracom/generated/cmd/sora_cam_devices_set_name.go b/soracom/generated/cmd/sora_cam_devices_set_name.go new file mode 100644 index 00000000..ca786f3a --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_set_name.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesSetNameCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesSetNameCmdDeviceId string + +// SoraCamDevicesSetNameCmdName holds value of 'name' option +var SoraCamDevicesSetNameCmdName string + +// SoraCamDevicesSetNameCmdBody holds contents of request body to be sent +var SoraCamDevicesSetNameCmdBody string + +func InitSoraCamDevicesSetNameCmd() { + SoraCamDevicesSetNameCmd.Flags().StringVar(&SoraCamDevicesSetNameCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesSetNameCmd.Flags().StringVar(&SoraCamDevicesSetNameCmdName, "name", "", TRAPI("")) + + SoraCamDevicesSetNameCmd.Flags().StringVar(&SoraCamDevicesSetNameCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesSetNameCmd.RunE = SoraCamDevicesSetNameCmdRunE + + SoraCamDevicesCmd.AddCommand(SoraCamDevicesSetNameCmd) +} + +// SoraCamDevicesSetNameCmd defines 'set-name' subcommand +var SoraCamDevicesSetNameCmd = &cobra.Command{ + Use: "set-name", + Short: TRAPI("/sora_cam/devices/{device_id}/name:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/name:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDeviceName"), +} + +func SoraCamDevicesSetNameCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesSetNameCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesSetNameCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesSetNameCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesSetNameCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesSetNameCmd("/sora_cam/devices/{device_id}/name"), + query: buildQueryForSoraCamDevicesSetNameCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesSetNameCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesSetNameCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesSetNameCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesSetNameCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesSetNameCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesSetNameCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesSetNameCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesSetNameCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesSetNameCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesSetNameCmdName != "" { + result["name"] = SoraCamDevicesSetNameCmdName + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_devices_set_power_state.go b/soracom/generated/cmd/sora_cam_devices_set_power_state.go new file mode 100644 index 00000000..7ed9d44e --- /dev/null +++ b/soracom/generated/cmd/sora_cam_devices_set_power_state.go @@ -0,0 +1,176 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// SoraCamDevicesSetPowerStateCmdDeviceId holds value of 'device_id' option +var SoraCamDevicesSetPowerStateCmdDeviceId string + +// SoraCamDevicesSetPowerStateCmdPowerState holds value of 'powerState' option +var SoraCamDevicesSetPowerStateCmdPowerState string + +// SoraCamDevicesSetPowerStateCmdBody holds contents of request body to be sent +var SoraCamDevicesSetPowerStateCmdBody string + +func InitSoraCamDevicesSetPowerStateCmd() { + SoraCamDevicesSetPowerStateCmd.Flags().StringVar(&SoraCamDevicesSetPowerStateCmdDeviceId, "device-id", "", TRAPI("Device ID of the target compatible camera device.")) + + SoraCamDevicesSetPowerStateCmd.Flags().StringVar(&SoraCamDevicesSetPowerStateCmdPowerState, "power-state", "", TRAPI("Power state of the compatible camera device.- 'on'- 'sleep'")) + + SoraCamDevicesSetPowerStateCmd.Flags().StringVar(&SoraCamDevicesSetPowerStateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + SoraCamDevicesSetPowerStateCmd.RunE = SoraCamDevicesSetPowerStateCmdRunE + + SoraCamDevicesCmd.AddCommand(SoraCamDevicesSetPowerStateCmd) +} + +// SoraCamDevicesSetPowerStateCmd defines 'set-power-state' subcommand +var SoraCamDevicesSetPowerStateCmd = &cobra.Command{ + Use: "set-power-state", + Short: TRAPI("/sora_cam/devices/{device_id}/power_state:post:summary"), + Long: TRAPI(`/sora_cam/devices/{device_id}/power_state:post:description`) + "\n\n" + createLinkToAPIReference("SoraCam", "setSoraCamDevicePowerState"), +} + +func SoraCamDevicesSetPowerStateCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectSoraCamDevicesSetPowerStateCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectSoraCamDevicesSetPowerStateCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + body, err = buildBodyForSoraCamDevicesSetPowerStateCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + err = checkIfRequiredStringParameterIsSupplied("device_id", "device-id", "path", parsedBody, SoraCamDevicesSetPowerStateCmdDeviceId) + if err != nil { + return nil, err + } + + return &apiParams{ + method: "POST", + path: buildPathForSoraCamDevicesSetPowerStateCmd("/sora_cam/devices/{device_id}/power_state"), + query: buildQueryForSoraCamDevicesSetPowerStateCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForSoraCamDevicesSetPowerStateCmd(path string) string { + + escapedDeviceId := url.PathEscape(SoraCamDevicesSetPowerStateCmdDeviceId) + + path = strReplace(path, "{"+"device_id"+"}", escapedDeviceId, -1) + + return path +} + +func buildQueryForSoraCamDevicesSetPowerStateCmd() url.Values { + result := url.Values{} + + return result +} + +func buildBodyForSoraCamDevicesSetPowerStateCmd() (string, error) { + var result map[string]interface{} + + if SoraCamDevicesSetPowerStateCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(SoraCamDevicesSetPowerStateCmdBody, "@") { + fname := strings.TrimPrefix(SoraCamDevicesSetPowerStateCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if SoraCamDevicesSetPowerStateCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(SoraCamDevicesSetPowerStateCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if SoraCamDevicesSetPowerStateCmdPowerState != "" { + result["powerState"] = SoraCamDevicesSetPowerStateCmdPowerState + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/sora_cam_license_packs_update_quantity.go b/soracom/generated/cmd/sora_cam_license_packs_update_quantity.go index fa4b5d93..f8ccff0f 100644 --- a/soracom/generated/cmd/sora_cam_license_packs_update_quantity.go +++ b/soracom/generated/cmd/sora_cam_license_packs_update_quantity.go @@ -26,11 +26,11 @@ var SoraCamLicensePacksUpdateQuantityCmdDesiredQuantity int64 var SoraCamLicensePacksUpdateQuantityCmdBody string func InitSoraCamLicensePacksUpdateQuantityCmd() { - SoraCamLicensePacksUpdateQuantityCmd.Flags().StringVar(&SoraCamLicensePacksUpdateQuantityCmdLicensePackId, "license-pack-id", "", TRAPI("ID of the license pack")) + SoraCamLicensePacksUpdateQuantityCmd.Flags().StringVar(&SoraCamLicensePacksUpdateQuantityCmdLicensePackId, "license-pack-id", "", TRAPI("ID of the license pack.")) - SoraCamLicensePacksUpdateQuantityCmd.Flags().Int64Var(&SoraCamLicensePacksUpdateQuantityCmdCurrentQuantity, "current-quantity", 0, TRAPI("Current license quantity of the license pack")) + SoraCamLicensePacksUpdateQuantityCmd.Flags().Int64Var(&SoraCamLicensePacksUpdateQuantityCmdCurrentQuantity, "current-quantity", 0, TRAPI("Current license quantity of the license pack.")) - SoraCamLicensePacksUpdateQuantityCmd.Flags().Int64Var(&SoraCamLicensePacksUpdateQuantityCmdDesiredQuantity, "desired-quantity", 0, TRAPI("Desired license quantity of the license pack")) + SoraCamLicensePacksUpdateQuantityCmd.Flags().Int64Var(&SoraCamLicensePacksUpdateQuantityCmdDesiredQuantity, "desired-quantity", 0, TRAPI("Desired license quantity of the license pack.")) SoraCamLicensePacksUpdateQuantityCmd.Flags().StringVar(&SoraCamLicensePacksUpdateQuantityCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/soralets_get_logs.go b/soracom/generated/cmd/soralets_get_logs.go index daafb512..37494601 100644 --- a/soracom/generated/cmd/soralets_get_logs.go +++ b/soracom/generated/cmd/soralets_get_logs.go @@ -32,7 +32,7 @@ func InitSoraletsGetLogsCmd() { SoraletsGetLogsCmd.Flags().StringVar(&SoraletsGetLogsCmdSoraletId, "soralet-id", "", TRAPI("The identifier of Soralet.")) - SoraletsGetLogsCmd.Flags().StringVar(&SoraletsGetLogsCmdSort, "sort", "desc", TRAPI("Sort order")) + SoraletsGetLogsCmd.Flags().StringVar(&SoraletsGetLogsCmdSort, "sort", "desc", TRAPI("Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).")) SoraletsGetLogsCmd.Flags().Int64Var(&SoraletsGetLogsCmdLimit, "limit", 0, TRAPI("The maximum number of items in a response.")) diff --git a/soracom/generated/cmd/soralets_list.go b/soracom/generated/cmd/soralets_list.go index bc89e813..2b6d96e9 100644 --- a/soracom/generated/cmd/soralets_list.go +++ b/soracom/generated/cmd/soralets_list.go @@ -27,9 +27,9 @@ var SoraletsListCmdOutputJSONL bool func InitSoraletsListCmd() { SoraletsListCmd.Flags().StringVar(&SoraletsListCmdLastEvaluatedKey, "last-evaluated-key", "", TRAPI("The identifier of the last Soralet retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Soralet onward.")) - SoraletsListCmd.Flags().StringVar(&SoraletsListCmdSort, "sort", "asc", TRAPI("Sort order")) + SoraletsListCmd.Flags().StringVar(&SoraletsListCmdSort, "sort", "asc", TRAPI("Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).")) - SoraletsListCmd.Flags().Int64Var(&SoraletsListCmdLimit, "limit", 0, TRAPI("The maximum number of items in a response")) + SoraletsListCmd.Flags().Int64Var(&SoraletsListCmdLimit, "limit", 0, TRAPI("The maximum number of items in a response.")) SoraletsListCmd.Flags().BoolVar(&SoraletsListCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/soracom/generated/cmd/soralets_list_versions.go b/soracom/generated/cmd/soralets_list_versions.go index 182a425a..ca18eb2f 100644 --- a/soracom/generated/cmd/soralets_list_versions.go +++ b/soracom/generated/cmd/soralets_list_versions.go @@ -32,7 +32,7 @@ func InitSoraletsListVersionsCmd() { SoraletsListVersionsCmd.Flags().StringVar(&SoraletsListVersionsCmdSoraletId, "soralet-id", "", TRAPI("The identifier of Soralet.")) - SoraletsListVersionsCmd.Flags().StringVar(&SoraletsListVersionsCmdSort, "sort", "desc", TRAPI("Sort order")) + SoraletsListVersionsCmd.Flags().StringVar(&SoraletsListVersionsCmdSort, "sort", "desc", TRAPI("Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first).")) SoraletsListVersionsCmd.Flags().Int64Var(&SoraletsListVersionsCmdLimit, "limit", 0, TRAPI("The maximum number of items in a response.")) diff --git a/soracom/generated/cmd/soralets_upload.go b/soracom/generated/cmd/soralets_upload.go index 448b3679..88c6f737 100644 --- a/soracom/generated/cmd/soralets_upload.go +++ b/soracom/generated/cmd/soralets_upload.go @@ -23,7 +23,7 @@ var SoraletsUploadCmdSoraletId string var SoraletsUploadCmdBody string func InitSoraletsUploadCmd() { - SoraletsUploadCmd.Flags().StringVar(&SoraletsUploadCmdContentType, "content-type", "", TRAPI("Content type of the file to upload")) + SoraletsUploadCmd.Flags().StringVar(&SoraletsUploadCmdContentType, "content-type", "", TRAPI("Content type of the file to upload. When uploading .wasm files, please specify 'application/json'.")) SoraletsUploadCmd.Flags().StringVar(&SoraletsUploadCmdSoraletId, "soralet-id", "", TRAPI("The identifier of Soralet.")) diff --git a/soracom/generated/cmd/stats_air_export.go b/soracom/generated/cmd/stats_air_export.go index 477a318e..d2abb875 100644 --- a/soracom/generated/cmd/stats_air_export.go +++ b/soracom/generated/cmd/stats_air_export.go @@ -32,15 +32,15 @@ var StatsAirExportCmdTo int64 var StatsAirExportCmdBody string func InitStatsAirExportCmd() { - StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdExportMode, "export-mode", "", TRAPI("Specify how to obtain the URL to download the Air Data Usage Report CSV.- 'async': Get the 'exportedFieldId' without waiting for the URL to be issued on the Soracom platform. Specify this 'exportedFieldId' in ['Files:getExportedFile API'](#/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify 'async'.- 'sync' (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify 'async'.")) + StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdExportMode, "export-mode", "", TRAPI("Specify how to obtain the URL to download the Air Data Usage Report CSV.- 'async': Get the 'exportedFieldId' without waiting for the URL to be issued on the Soracom platform. Specify this 'exportedFieldId' in ['Files:getExportedFile API'](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify 'async'.- 'sync' (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify 'async'.")) StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdPeriod, "period", "", TRAPI("Degree of detail of history.- 'month': Monthly- 'day': Daily- 'minutes': Every minute")) + StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsAirExportCmd.Flags().Int64Var(&StatsAirExportCmdFrom, "from", 0, TRAPI("Start date and time for the aggregate data (UNIX time in seconds)")) + StatsAirExportCmd.Flags().Int64Var(&StatsAirExportCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsAirExportCmd.Flags().Int64Var(&StatsAirExportCmdTo, "to", 0, TRAPI("End date and time of the period covered (UNIX time in seconds)")) + StatsAirExportCmd.Flags().Int64Var(&StatsAirExportCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsAirExportCmd.Flags().StringVar(&StatsAirExportCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/stats_air_get.go b/soracom/generated/cmd/stats_air_get.go index 981e2283..24973ab1 100644 --- a/soracom/generated/cmd/stats_air_get.go +++ b/soracom/generated/cmd/stats_air_get.go @@ -27,11 +27,11 @@ var StatsAirGetCmdOutputJSONL bool func InitStatsAirGetCmd() { StatsAirGetCmd.Flags().StringVar(&StatsAirGetCmdImsi, "imsi", "", TRAPI("imsi")) - StatsAirGetCmd.Flags().StringVar(&StatsAirGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the history of traffic at the finest granularity. However, while the device is connected to the Soracom platform, the communication volume is recorded at approximately 5-minute intervals.")) + StatsAirGetCmd.Flags().StringVar(&StatsAirGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsAirGetCmd.Flags().Int64Var(&StatsAirGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsAirGetCmd.Flags().Int64Var(&StatsAirGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsAirGetCmd.Flags().Int64Var(&StatsAirGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsAirGetCmd.Flags().Int64Var(&StatsAirGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsAirGetCmd.Flags().BoolVar(&StatsAirGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_air_groups_get.go b/soracom/generated/cmd/stats_air_groups_get.go index e7766b22..0f0c7627 100644 --- a/soracom/generated/cmd/stats_air_groups_get.go +++ b/soracom/generated/cmd/stats_air_groups_get.go @@ -27,11 +27,11 @@ var StatsAirGroupsGetCmdOutputJSONL bool func InitStatsAirGroupsGetCmd() { StatsAirGroupsGetCmd.Flags().StringVar(&StatsAirGroupsGetCmdGroupId, "group-id", "", TRAPI("Group ID")) - StatsAirGroupsGetCmd.Flags().StringVar(&StatsAirGroupsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- month: Aggregate by month.- day: Aggregate by day.")) + StatsAirGroupsGetCmd.Flags().StringVar(&StatsAirGroupsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Monthly. The 'from' and 'to' should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Daily The 'from' and 'to' should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |")) - StatsAirGroupsGetCmd.Flags().Int64Var(&StatsAirGroupsGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).- If period is set to \"month\", valid values range from 3 months ago to the current time. - If period is set to \"day\", valid values range from 6 days ago to the current time. - The actual start time of the period is 00:00:00 on the first day of the month or day containing the specified UNIX time.")) + StatsAirGroupsGetCmd.Flags().Int64Var(&StatsAirGroupsGetCmdFrom, "from", 0, TRAPI("Specify the start month/day of the period to be aggregated in UNIX time in seconds.")) - StatsAirGroupsGetCmd.Flags().Int64Var(&StatsAirGroupsGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).- If period is set to \"month\", valid values range from 3 months ago to the current time.- If period is set to \"day\", valid values range from 6 days ago to the current time.- The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time.")) + StatsAirGroupsGetCmd.Flags().Int64Var(&StatsAirGroupsGetCmdTo, "to", 0, TRAPI("Specify the end month/day of the period to be aggregated in UNIX time in seconds.")) StatsAirGroupsGetCmd.Flags().BoolVar(&StatsAirGroupsGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_air_operators_get.go b/soracom/generated/cmd/stats_air_operators_get.go index f3abfa9d..ccc245c9 100644 --- a/soracom/generated/cmd/stats_air_operators_get.go +++ b/soracom/generated/cmd/stats_air_operators_get.go @@ -27,11 +27,11 @@ var StatsAirOperatorsGetCmdOutputJSONL bool func InitStatsAirOperatorsGetCmd() { StatsAirOperatorsGetCmd.Flags().StringVar(&StatsAirOperatorsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsAirOperatorsGetCmd.Flags().StringVar(&StatsAirOperatorsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- month: Aggregate by month.- day: Aggregate by day.")) + StatsAirOperatorsGetCmd.Flags().StringVar(&StatsAirOperatorsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Monthly. The 'from' and 'to' should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Daily The 'from' and 'to' should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |")) - StatsAirOperatorsGetCmd.Flags().Int64Var(&StatsAirOperatorsGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).- If period is set to \"month\", valid values range from 3 months ago to the current time. - If period is set to \"day\", valid values range from 6 days ago to the current time. - The actual start time of the period is 00:00:00 on the first day of the month or day containing the specified UNIX time.")) + StatsAirOperatorsGetCmd.Flags().Int64Var(&StatsAirOperatorsGetCmdFrom, "from", 0, TRAPI("Specify the start month/day of the period to be aggregated in UNIX time in seconds.")) - StatsAirOperatorsGetCmd.Flags().Int64Var(&StatsAirOperatorsGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).- If period is set to \"month\", valid values range from 3 months ago to the current time.- If period is set to \"day\", valid values range from 6 days ago to the current time.- The actual end time of the period is 24:00:00 on the last day of the month or day containing the specified UNIX time.")) + StatsAirOperatorsGetCmd.Flags().Int64Var(&StatsAirOperatorsGetCmdTo, "to", 0, TRAPI("Specify the end month/day of the period to be aggregated in UNIX time in seconds.")) StatsAirOperatorsGetCmd.Flags().BoolVar(&StatsAirOperatorsGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_air_sims_get.go b/soracom/generated/cmd/stats_air_sims_get.go index c476e804..72dd8836 100644 --- a/soracom/generated/cmd/stats_air_sims_get.go +++ b/soracom/generated/cmd/stats_air_sims_get.go @@ -25,13 +25,13 @@ var StatsAirSimsGetCmdTo int64 var StatsAirSimsGetCmdOutputJSONL bool func InitStatsAirSimsGetCmd() { - StatsAirSimsGetCmd.Flags().StringVar(&StatsAirSimsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the history of traffic at the finest granularity. However, while the device is connected to the Soracom platform, the communication volume is recorded at approximately 5-minute intervals.")) + StatsAirSimsGetCmd.Flags().StringVar(&StatsAirSimsGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) StatsAirSimsGetCmd.Flags().StringVar(&StatsAirSimsGetCmdSimId, "sim-id", "", TRAPI("SIM ID")) - StatsAirSimsGetCmd.Flags().Int64Var(&StatsAirSimsGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsAirSimsGetCmd.Flags().Int64Var(&StatsAirSimsGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsAirSimsGetCmd.Flags().Int64Var(&StatsAirSimsGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsAirSimsGetCmd.Flags().Int64Var(&StatsAirSimsGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsAirSimsGetCmd.Flags().BoolVar(&StatsAirSimsGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_beam_export.go b/soracom/generated/cmd/stats_beam_export.go index 14d9ee38..6131adfe 100644 --- a/soracom/generated/cmd/stats_beam_export.go +++ b/soracom/generated/cmd/stats_beam_export.go @@ -36,11 +36,11 @@ func InitStatsBeamExportCmd() { StatsBeamExportCmd.Flags().StringVar(&StatsBeamExportCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsBeamExportCmd.Flags().StringVar(&StatsBeamExportCmdPeriod, "period", "", TRAPI("Degree of detail of history.- 'month': Monthly- 'day': Daily- 'minutes': Every minute")) + StatsBeamExportCmd.Flags().StringVar(&StatsBeamExportCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsBeamExportCmd.Flags().Int64Var(&StatsBeamExportCmdFrom, "from", 0, TRAPI("Start date and time for the aggregate data (UNIX time in seconds)")) + StatsBeamExportCmd.Flags().Int64Var(&StatsBeamExportCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsBeamExportCmd.Flags().Int64Var(&StatsBeamExportCmdTo, "to", 0, TRAPI("End date and time of the period covered (UNIX time in seconds)")) + StatsBeamExportCmd.Flags().Int64Var(&StatsBeamExportCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsBeamExportCmd.Flags().StringVar(&StatsBeamExportCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/stats_beam_get.go b/soracom/generated/cmd/stats_beam_get.go index eb2e78f5..8896fc90 100644 --- a/soracom/generated/cmd/stats_beam_get.go +++ b/soracom/generated/cmd/stats_beam_get.go @@ -27,11 +27,11 @@ var StatsBeamGetCmdOutputJSONL bool func InitStatsBeamGetCmd() { StatsBeamGetCmd.Flags().StringVar(&StatsBeamGetCmdImsi, "imsi", "", TRAPI("imsi")) - StatsBeamGetCmd.Flags().StringVar(&StatsBeamGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the usage report at the finest granularity. However, while the device is connected to the Soracom platform, the amount of usage will be recorded at approximately 5-minute intervals.")) + StatsBeamGetCmd.Flags().StringVar(&StatsBeamGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsBeamGetCmd.Flags().Int64Var(&StatsBeamGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsBeamGetCmd.Flags().Int64Var(&StatsBeamGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsBeamGetCmd.Flags().Int64Var(&StatsBeamGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsBeamGetCmd.Flags().Int64Var(&StatsBeamGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsBeamGetCmd.Flags().BoolVar(&StatsBeamGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_funk_export.go b/soracom/generated/cmd/stats_funk_export.go index b3665d2d..17cf0430 100644 --- a/soracom/generated/cmd/stats_funk_export.go +++ b/soracom/generated/cmd/stats_funk_export.go @@ -36,11 +36,11 @@ func InitStatsFunkExportCmd() { StatsFunkExportCmd.Flags().StringVar(&StatsFunkExportCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsFunkExportCmd.Flags().StringVar(&StatsFunkExportCmdPeriod, "period", "", TRAPI("Degree of detail of history.- 'month': Monthly- 'day': Daily- 'minutes': Every minute")) + StatsFunkExportCmd.Flags().StringVar(&StatsFunkExportCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsFunkExportCmd.Flags().Int64Var(&StatsFunkExportCmdFrom, "from", 0, TRAPI("Start date and time for the aggregate data (UNIX time in seconds)")) + StatsFunkExportCmd.Flags().Int64Var(&StatsFunkExportCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsFunkExportCmd.Flags().Int64Var(&StatsFunkExportCmdTo, "to", 0, TRAPI("End date and time of the period covered (UNIX time in seconds)")) + StatsFunkExportCmd.Flags().Int64Var(&StatsFunkExportCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsFunkExportCmd.Flags().StringVar(&StatsFunkExportCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/stats_funk_get.go b/soracom/generated/cmd/stats_funk_get.go index 3e6f6618..da7111df 100644 --- a/soracom/generated/cmd/stats_funk_get.go +++ b/soracom/generated/cmd/stats_funk_get.go @@ -27,11 +27,11 @@ var StatsFunkGetCmdOutputJSONL bool func InitStatsFunkGetCmd() { StatsFunkGetCmd.Flags().StringVar(&StatsFunkGetCmdImsi, "imsi", "", TRAPI("imsi")) - StatsFunkGetCmd.Flags().StringVar(&StatsFunkGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the usage report at the finest granularity. However, while the device is connected to the Soracom platform, the amount of usage will be recorded at approximately 5-minute intervals.")) + StatsFunkGetCmd.Flags().StringVar(&StatsFunkGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsFunkGetCmd.Flags().Int64Var(&StatsFunkGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsFunkGetCmd.Flags().Int64Var(&StatsFunkGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsFunkGetCmd.Flags().Int64Var(&StatsFunkGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsFunkGetCmd.Flags().Int64Var(&StatsFunkGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsFunkGetCmd.Flags().BoolVar(&StatsFunkGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_funnel_export.go b/soracom/generated/cmd/stats_funnel_export.go index a2d0e137..f16ece02 100644 --- a/soracom/generated/cmd/stats_funnel_export.go +++ b/soracom/generated/cmd/stats_funnel_export.go @@ -36,11 +36,11 @@ func InitStatsFunnelExportCmd() { StatsFunnelExportCmd.Flags().StringVar(&StatsFunnelExportCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsFunnelExportCmd.Flags().StringVar(&StatsFunnelExportCmdPeriod, "period", "", TRAPI("Degree of detail of history.- 'month': Monthly- 'day': Daily- 'minutes': Every minute")) + StatsFunnelExportCmd.Flags().StringVar(&StatsFunnelExportCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsFunnelExportCmd.Flags().Int64Var(&StatsFunnelExportCmdFrom, "from", 0, TRAPI("Start date and time for the aggregate data (UNIX time in seconds)")) + StatsFunnelExportCmd.Flags().Int64Var(&StatsFunnelExportCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsFunnelExportCmd.Flags().Int64Var(&StatsFunnelExportCmdTo, "to", 0, TRAPI("End date and time of the period covered (UNIX time in seconds)")) + StatsFunnelExportCmd.Flags().Int64Var(&StatsFunnelExportCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsFunnelExportCmd.Flags().StringVar(&StatsFunnelExportCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/stats_funnel_get.go b/soracom/generated/cmd/stats_funnel_get.go index 27e7f201..731c5ec9 100644 --- a/soracom/generated/cmd/stats_funnel_get.go +++ b/soracom/generated/cmd/stats_funnel_get.go @@ -27,11 +27,11 @@ var StatsFunnelGetCmdOutputJSONL bool func InitStatsFunnelGetCmd() { StatsFunnelGetCmd.Flags().StringVar(&StatsFunnelGetCmdImsi, "imsi", "", TRAPI("imsi")) - StatsFunnelGetCmd.Flags().StringVar(&StatsFunnelGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the usage report at the finest granularity. However, while the device is connected to the Soracom platform, the amount of usage will be recorded at approximately 5-minute intervals.")) + StatsFunnelGetCmd.Flags().StringVar(&StatsFunnelGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsFunnelGetCmd.Flags().Int64Var(&StatsFunnelGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsFunnelGetCmd.Flags().Int64Var(&StatsFunnelGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsFunnelGetCmd.Flags().Int64Var(&StatsFunnelGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsFunnelGetCmd.Flags().Int64Var(&StatsFunnelGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsFunnelGetCmd.Flags().BoolVar(&StatsFunnelGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_harvest_export.go b/soracom/generated/cmd/stats_harvest_export.go new file mode 100644 index 00000000..fb4aa4c3 --- /dev/null +++ b/soracom/generated/cmd/stats_harvest_export.go @@ -0,0 +1,203 @@ +// Code generated by soracom-cli generate-cmd. DO NOT EDIT. +package cmd + +import ( + "encoding/json" + "fmt" + "io" + "net/url" + "os" + + "strings" + + "github.com/spf13/cobra" +) + +// StatsHarvestExportCmdExportMode holds value of 'export_mode' option +var StatsHarvestExportCmdExportMode string + +// StatsHarvestExportCmdOperatorId holds value of 'operator_id' option +var StatsHarvestExportCmdOperatorId string + +// StatsHarvestExportCmdPeriod holds value of 'period' option +var StatsHarvestExportCmdPeriod string + +// StatsHarvestExportCmdFrom holds value of 'from' option +var StatsHarvestExportCmdFrom int64 + +// StatsHarvestExportCmdTo holds value of 'to' option +var StatsHarvestExportCmdTo int64 + +// StatsHarvestExportCmdBody holds contents of request body to be sent +var StatsHarvestExportCmdBody string + +func InitStatsHarvestExportCmd() { + StatsHarvestExportCmd.Flags().StringVar(&StatsHarvestExportCmdExportMode, "export-mode", "", TRAPI("Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV.- 'async': Get the 'exportedFieldId' without waiting for the URL to be issued on the Soracom platform. Specify this 'exportedFieldId' in ['Files:getExportedFile API'](#!/Files/getExportedFile) to get the URL. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify 'async'.- 'sync' (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify 'async'.")) + + StatsHarvestExportCmd.Flags().StringVar(&StatsHarvestExportCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) + + StatsHarvestExportCmd.Flags().StringVar(&StatsHarvestExportCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) + + StatsHarvestExportCmd.Flags().Int64Var(&StatsHarvestExportCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) + + StatsHarvestExportCmd.Flags().Int64Var(&StatsHarvestExportCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) + + StatsHarvestExportCmd.Flags().StringVar(&StatsHarvestExportCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) + + StatsHarvestExportCmd.RunE = StatsHarvestExportCmdRunE + + StatsHarvestCmd.AddCommand(StatsHarvestExportCmd) +} + +// StatsHarvestExportCmd defines 'export' subcommand +var StatsHarvestExportCmd = &cobra.Command{ + Use: "export", + Short: TRAPI("/stats/harvest/operators/{operator_id}/export:post:summary"), + Long: TRAPI(`/stats/harvest/operators/{operator_id}/export:post:description`) + "\n\n" + createLinkToAPIReference("Stats", "exportHarvestStats"), +} + +func StatsHarvestExportCmdRunE(cmd *cobra.Command, args []string) error { + + if len(args) > 0 { + return fmt.Errorf("unexpected arguments passed => %v", args) + } + + opt := &apiClientOptions{ + BasePath: "/v1", + Language: getSelectedLanguage(), + } + + ac := newAPIClient(opt) + if v := os.Getenv("SORACOM_VERBOSE"); v != "" { + ac.SetVerbose(true) + } + err := ac.getAPICredentials() + if err != nil { + cmd.SilenceUsage = true + return err + } + + param, err := collectStatsHarvestExportCmdParams(ac) + if err != nil { + return err + } + + body, err := ac.callAPI(param) + if err != nil { + cmd.SilenceUsage = true + return err + } + + if body == "" { + return nil + } + rawOutput = true + + if rawOutput { + _, err = os.Stdout.Write([]byte(body)) + } else { + return prettyPrintStringAsJSON(body) + } + return err +} + +func collectStatsHarvestExportCmdParams(ac *apiClient) (*apiParams, error) { + var body string + var parsedBody interface{} + var err error + if StatsHarvestExportCmdOperatorId == "" { + StatsHarvestExportCmdOperatorId = ac.apiCredentials.getOperatorID() + } + + body, err = buildBodyForStatsHarvestExportCmd() + if err != nil { + return nil, err + } + contentType := "application/json" + + if contentType == "application/json" { + err = json.Unmarshal([]byte(body), &parsedBody) + if err != nil { + return nil, fmt.Errorf("invalid json format specified for `--body` parameter: %s", err) + } + } + + return &apiParams{ + method: "POST", + path: buildPathForStatsHarvestExportCmd("/stats/harvest/operators/{operator_id}/export"), + query: buildQueryForStatsHarvestExportCmd(), + contentType: contentType, + body: body, + + noRetryOnError: noRetryOnError, + }, nil +} + +func buildPathForStatsHarvestExportCmd(path string) string { + + escapedOperatorId := url.PathEscape(StatsHarvestExportCmdOperatorId) + + path = strReplace(path, "{"+"operator_id"+"}", escapedOperatorId, -1) + + return path +} + +func buildQueryForStatsHarvestExportCmd() url.Values { + result := url.Values{} + + if StatsHarvestExportCmdExportMode != "" { + result.Add("export_mode", StatsHarvestExportCmdExportMode) + } + + return result +} + +func buildBodyForStatsHarvestExportCmd() (string, error) { + var result map[string]interface{} + + if StatsHarvestExportCmdBody != "" { + var b []byte + var err error + + if strings.HasPrefix(StatsHarvestExportCmdBody, "@") { + fname := strings.TrimPrefix(StatsHarvestExportCmdBody, "@") + // #nosec + b, err = os.ReadFile(fname) + } else if StatsHarvestExportCmdBody == "-" { + b, err = io.ReadAll(os.Stdin) + } else { + b = []byte(StatsHarvestExportCmdBody) + } + + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &result) + if err != nil { + return "", err + } + } + + if result == nil { + result = make(map[string]interface{}) + } + + if StatsHarvestExportCmdPeriod != "" { + result["period"] = StatsHarvestExportCmdPeriod + } + + if StatsHarvestExportCmd.Flags().Lookup("from").Changed { + result["from"] = StatsHarvestExportCmdFrom + } + + if StatsHarvestExportCmd.Flags().Lookup("to").Changed { + result["to"] = StatsHarvestExportCmdTo + } + + resultBytes, err := json.Marshal(result) + if err != nil { + return "", err + } + return string(resultBytes), nil +} diff --git a/soracom/generated/cmd/stats_harvest_operators_get.go b/soracom/generated/cmd/stats_harvest_operators_get.go index 6229ec02..a72a2da0 100644 --- a/soracom/generated/cmd/stats_harvest_operators_get.go +++ b/soracom/generated/cmd/stats_harvest_operators_get.go @@ -18,7 +18,7 @@ var StatsHarvestOperatorsGetCmdYearMonth string func InitStatsHarvestOperatorsGetCmd() { StatsHarvestOperatorsGetCmd.Flags().StringVar(&StatsHarvestOperatorsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) - StatsHarvestOperatorsGetCmd.Flags().StringVar(&StatsHarvestOperatorsGetCmdYearMonth, "year-month", "", TRAPI("Year/Month in 'YYYYMM' format.")) + StatsHarvestOperatorsGetCmd.Flags().StringVar(&StatsHarvestOperatorsGetCmdYearMonth, "year-month", "", TRAPI("Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.")) StatsHarvestOperatorsGetCmd.RunE = StatsHarvestOperatorsGetCmdRunE diff --git a/soracom/generated/cmd/stats_harvest_subscribers_get.go b/soracom/generated/cmd/stats_harvest_subscribers_get.go index 8705599b..143e964d 100644 --- a/soracom/generated/cmd/stats_harvest_subscribers_get.go +++ b/soracom/generated/cmd/stats_harvest_subscribers_get.go @@ -27,11 +27,11 @@ var StatsHarvestSubscribersGetCmdOutputJSONL bool func InitStatsHarvestSubscribersGetCmd() { StatsHarvestSubscribersGetCmd.Flags().StringVar(&StatsHarvestSubscribersGetCmdImsi, "imsi", "", TRAPI("imsi")) - StatsHarvestSubscribersGetCmd.Flags().StringVar(&StatsHarvestSubscribersGetCmdPeriod, "period", "", TRAPI("Unit of aggregation. minutes outputs the usage report at the finest granularity. However, while the device is connected to the Soracom platform, the amount of usage will be recorded at approximately 5-minute intervals.")) + StatsHarvestSubscribersGetCmd.Flags().StringVar(&StatsHarvestSubscribersGetCmdPeriod, "period", "", TRAPI("Unit of aggregation.- 'month': Aggregate by month. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |- 'day': Aggregate by day. The 'from' and 'to' should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). | | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |- 'minutes': Aggregate by approximately every 5 minutes. The 'from' and 'to' must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by 'from' and 'to'. | Item | Description | |-|-| | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). | | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |")) - StatsHarvestSubscribersGetCmd.Flags().Int64Var(&StatsHarvestSubscribersGetCmdFrom, "from", 0, TRAPI("Start time for the aggregate data (UNIX time in seconds).")) + StatsHarvestSubscribersGetCmd.Flags().Int64Var(&StatsHarvestSubscribersGetCmdFrom, "from", 0, TRAPI("Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds.")) - StatsHarvestSubscribersGetCmd.Flags().Int64Var(&StatsHarvestSubscribersGetCmdTo, "to", 0, TRAPI("End time for the aggregate data (UNIX time in seconds).")) + StatsHarvestSubscribersGetCmd.Flags().Int64Var(&StatsHarvestSubscribersGetCmdTo, "to", 0, TRAPI("Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds.")) StatsHarvestSubscribersGetCmd.Flags().BoolVar(&StatsHarvestSubscribersGetCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/stats_napter_audit_logs_get.go b/soracom/generated/cmd/stats_napter_audit_logs_get.go index d9be17e1..7e7cd5dd 100644 --- a/soracom/generated/cmd/stats_napter_audit_logs_get.go +++ b/soracom/generated/cmd/stats_napter_audit_logs_get.go @@ -13,7 +13,7 @@ import ( var StatsNapterAuditLogsGetCmdYearMonth string func InitStatsNapterAuditLogsGetCmd() { - StatsNapterAuditLogsGetCmd.Flags().StringVar(&StatsNapterAuditLogsGetCmdYearMonth, "year-month", "", TRAPI("Year/Month in 'YYYYMM' format.")) + StatsNapterAuditLogsGetCmd.Flags().StringVar(&StatsNapterAuditLogsGetCmdYearMonth, "year-month", "", TRAPI("Specify the year and month from 18 months before the current time to the current time in the YYYYMM format.")) StatsNapterAuditLogsGetCmd.RunE = StatsNapterAuditLogsGetCmdRunE diff --git a/soracom/generated/cmd/subscribers_get_data.go b/soracom/generated/cmd/subscribers_get_data.go index a85af0ad..2e408777 100644 --- a/soracom/generated/cmd/subscribers_get_data.go +++ b/soracom/generated/cmd/subscribers_get_data.go @@ -42,7 +42,7 @@ func InitSubscribersGetDataCmd() { SubscribersGetDataCmd.Flags().Int64Var(&SubscribersGetDataCmdFrom, "from", 0, TRAPI("Start time for the data entries search range (UNIX time in milliseconds).")) - SubscribersGetDataCmd.Flags().Int64Var(&SubscribersGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve. The default is '10'.")) + SubscribersGetDataCmd.Flags().Int64Var(&SubscribersGetDataCmdLimit, "limit", 0, TRAPI("Maximum number of data entries to retrieve (value range is 1 to 1000). The default is '10'.")) SubscribersGetDataCmd.Flags().Int64Var(&SubscribersGetDataCmdTo, "to", 0, TRAPI("End time for the data entries search range (UNIX time in milliseconds).")) diff --git a/soracom/generated/cmd/subscribers_list.go b/soracom/generated/cmd/subscribers_list.go index ce2f4e82..ff2fe6b2 100644 --- a/soracom/generated/cmd/subscribers_list.go +++ b/soracom/generated/cmd/subscribers_list.go @@ -44,7 +44,7 @@ func InitSubscribersListCmd() { SubscribersListCmd.Flags().StringVar(&SubscribersListCmdSerialNumberFilter, "serial-number-filter", "", TRAPI("Serial number for filtering the search. Can specify multiple values delimited by '|'. Returns subscribers with serial number starting with the specified value(s).")) - SubscribersListCmd.Flags().StringVar(&SubscribersListCmdSpeedClassFilter, "speed-class-filter", "", TRAPI("Speed class for filtering the search. Can specify multiple values delimited by '|'. Valid values include: 's1.minimum', 's1.slow', 's1.standard', 's1.fast'")) + SubscribersListCmd.Flags().StringVar(&SubscribersListCmdSpeedClassFilter, "speed-class-filter", "", TRAPI("Speed class for filtering the search. Can specify multiple values delimited by '|'. Valid values include:- 's1.minimum'- 's1.slow'- 's1.standard'- 's1.fast'- 's1.4xfast'- 's1.8xfast'- 'u1.standard'- 'u1.slow'- 't1.standard'- 'arc.standard'")) SubscribersListCmd.Flags().StringVar(&SubscribersListCmdStatusFilter, "status-filter", "", TRAPI("Status for filtering the search. Can specify multiple values delimited by '|'. Valid values include: 'active', 'inactive', 'ready', 'instock', 'shipped', 'suspended', and 'terminated'.")) diff --git a/soracom/generated/cmd/subscribers_register.go b/soracom/generated/cmd/subscribers_register.go index 90c39114..6291464a 100644 --- a/soracom/generated/cmd/subscribers_register.go +++ b/soracom/generated/cmd/subscribers_register.go @@ -30,7 +30,7 @@ func InitSubscribersRegisterCmd() { SubscribersRegisterCmd.Flags().StringVar(&SubscribersRegisterCmdImsi, "imsi", "", TRAPI("IMSI of the target subscriber.")) - SubscribersRegisterCmd.Flags().StringVar(&SubscribersRegisterCmdRegistrationSecret, "registration-secret", "", TRAPI("PUK or PASSCODE for IoT SIM")) + SubscribersRegisterCmd.Flags().StringVar(&SubscribersRegisterCmdRegistrationSecret, "registration-secret", "", TRAPI("PUK or PASSCODE for IoT SIM.")) SubscribersRegisterCmd.Flags().StringVar(&SubscribersRegisterCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/subscribers_set_imei_lock.go b/soracom/generated/cmd/subscribers_set_imei_lock.go index fdbef46f..25d4a3ee 100644 --- a/soracom/generated/cmd/subscribers_set_imei_lock.go +++ b/soracom/generated/cmd/subscribers_set_imei_lock.go @@ -23,7 +23,7 @@ var SubscribersSetImeiLockCmdImsi string var SubscribersSetImeiLockCmdBody string func InitSubscribersSetImeiLockCmd() { - SubscribersSetImeiLockCmd.Flags().StringVar(&SubscribersSetImeiLockCmdImei, "imei", "", TRAPI("")) + SubscribersSetImeiLockCmd.Flags().StringVar(&SubscribersSetImeiLockCmdImei, "imei", "", TRAPI("IMEI of the target device. If you want to establish a session even when the IMEI is temporarily not reported, append '|ANONYMOUS' to the IMEI value.For example, if the IMEI specified is '123456789012345', specifying '123456789012345|ANONYMOUS' as the parameter value will allow a session to be established even when the IMEI is temporarily not reported.")) SubscribersSetImeiLockCmd.Flags().StringVar(&SubscribersSetImeiLockCmdImsi, "imsi", "", TRAPI("IMSI of the target subscriber.")) diff --git a/soracom/generated/cmd/subscribers_update_speed_class.go b/soracom/generated/cmd/subscribers_update_speed_class.go index fab4e08b..24f223ec 100644 --- a/soracom/generated/cmd/subscribers_update_speed_class.go +++ b/soracom/generated/cmd/subscribers_update_speed_class.go @@ -25,7 +25,7 @@ var SubscribersUpdateSpeedClassCmdBody string func InitSubscribersUpdateSpeedClassCmd() { SubscribersUpdateSpeedClassCmd.Flags().StringVar(&SubscribersUpdateSpeedClassCmdImsi, "imsi", "", TRAPI("IMSI of the target subscriber.")) - SubscribersUpdateSpeedClassCmd.Flags().StringVar(&SubscribersUpdateSpeedClassCmdSpeedClass, "speed-class", "", TRAPI("Speed class. Specify one of the following. Please specify the speed class that matches the subscription.- For plan01s, plan01s - Low Data Volume, planP1, planX3 X3-5MB, plan-D: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast'- For plan-KM1: - 't1.standard'- For plan-DU: - 'u1.standard' - 'u1.slow'- For virtual SIM/Subscriber: - 'arc.standard'")) + SubscribersUpdateSpeedClassCmd.Flags().StringVar(&SubscribersUpdateSpeedClassCmdSpeedClass, "speed-class", "", TRAPI("Speed class. Specify one of the following. Please specify the speed class that matches the subscription.- For plan01s, plan01s - Low Data Volume, planX3 X3-5MB, planP1, plan-D, plan-D D-300MB, plan-K2 K2-300MB, plan-K: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast'- For plan-US: - 's1.minimum' - 's1.slow' - 's1.standard' - 's1.fast' - 's1.4xfast' - 's1.8xfast'- For plan-DU: - 'u1.standard' - 'u1.slow'- For plan-KM1: - 't1.standard'- For virtual SIM/Subscriber: - 'arc.standard'")) SubscribersUpdateSpeedClassCmd.Flags().StringVar(&SubscribersUpdateSpeedClassCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/system_notifications_delete.go b/soracom/generated/cmd/system_notifications_delete.go index 8014b908..4b3c557c 100644 --- a/soracom/generated/cmd/system_notifications_delete.go +++ b/soracom/generated/cmd/system_notifications_delete.go @@ -16,9 +16,9 @@ var SystemNotificationsDeleteCmdOperatorId string var SystemNotificationsDeleteCmdType string func InitSystemNotificationsDeleteCmd() { - SystemNotificationsDeleteCmd.Flags().StringVar(&SystemNotificationsDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + SystemNotificationsDeleteCmd.Flags().StringVar(&SystemNotificationsDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - SystemNotificationsDeleteCmd.Flags().StringVar(&SystemNotificationsDeleteCmdType, "type", "", TRAPI("system notification type")) + SystemNotificationsDeleteCmd.Flags().StringVar(&SystemNotificationsDeleteCmdType, "type", "", TRAPI("Email address type.")) SystemNotificationsDeleteCmd.RunE = SystemNotificationsDeleteCmdRunE diff --git a/soracom/generated/cmd/system_notifications_get.go b/soracom/generated/cmd/system_notifications_get.go index 5ef3379c..3ae1559b 100644 --- a/soracom/generated/cmd/system_notifications_get.go +++ b/soracom/generated/cmd/system_notifications_get.go @@ -16,9 +16,9 @@ var SystemNotificationsGetCmdOperatorId string var SystemNotificationsGetCmdType string func InitSystemNotificationsGetCmd() { - SystemNotificationsGetCmd.Flags().StringVar(&SystemNotificationsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + SystemNotificationsGetCmd.Flags().StringVar(&SystemNotificationsGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - SystemNotificationsGetCmd.Flags().StringVar(&SystemNotificationsGetCmdType, "type", "", TRAPI("system notification type")) + SystemNotificationsGetCmd.Flags().StringVar(&SystemNotificationsGetCmdType, "type", "", TRAPI("Email address type.")) SystemNotificationsGetCmd.RunE = SystemNotificationsGetCmdRunE diff --git a/soracom/generated/cmd/system_notifications_set.go b/soracom/generated/cmd/system_notifications_set.go index eae183cd..03e39e44 100644 --- a/soracom/generated/cmd/system_notifications_set.go +++ b/soracom/generated/cmd/system_notifications_set.go @@ -33,7 +33,7 @@ func InitSystemNotificationsSetCmd() { SystemNotificationsSetCmd.Flags().StringVar(&SystemNotificationsSetCmdPassword, "password", "", TRAPI("Password of the operator. This is necessary when type is primary.")) - SystemNotificationsSetCmd.Flags().StringVar(&SystemNotificationsSetCmdType, "type", "", TRAPI("system notification type")) + SystemNotificationsSetCmd.Flags().StringVar(&SystemNotificationsSetCmdType, "type", "", TRAPI("Email address type.")) SystemNotificationsSetCmd.Flags().StringSliceVar(&SystemNotificationsSetCmdEmailIdList, "email-id-list", []string{}, TRAPI("")) diff --git a/soracom/generated/cmd/users_attach_role.go b/soracom/generated/cmd/users_attach_role.go index 04a1eeca..5501d0d8 100644 --- a/soracom/generated/cmd/users_attach_role.go +++ b/soracom/generated/cmd/users_attach_role.go @@ -26,11 +26,11 @@ var UsersAttachRoleCmdUserName string var UsersAttachRoleCmdBody string func InitUsersAttachRoleCmd() { - UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdRoleId, "role-id", "", TRAPI("")) - UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdUserName, "user-name", "", TRAPI("user_name")) + UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdUserName, "user-name", "", TRAPI("SAM user name.")) UsersAttachRoleCmd.Flags().StringVar(&UsersAttachRoleCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/users_detach_role.go b/soracom/generated/cmd/users_detach_role.go index 9ce3af50..0ea17f45 100644 --- a/soracom/generated/cmd/users_detach_role.go +++ b/soracom/generated/cmd/users_detach_role.go @@ -19,11 +19,11 @@ var UsersDetachRoleCmdRoleId string var UsersDetachRoleCmdUserName string func InitUsersDetachRoleCmd() { - UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdRoleId, "role-id", "", TRAPI("role_id")) + UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdRoleId, "role-id", "", TRAPI("Role ID.")) - UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdUserName, "user-name", "", TRAPI("user_name")) + UsersDetachRoleCmd.Flags().StringVar(&UsersDetachRoleCmdUserName, "user-name", "", TRAPI("SAM user name.")) UsersDetachRoleCmd.RunE = UsersDetachRoleCmdRunE diff --git a/soracom/generated/cmd/users_list_roles.go b/soracom/generated/cmd/users_list_roles.go index 207a32ac..95be2888 100644 --- a/soracom/generated/cmd/users_list_roles.go +++ b/soracom/generated/cmd/users_list_roles.go @@ -19,9 +19,9 @@ var UsersListRolesCmdUserName string var UsersListRolesCmdOutputJSONL bool func InitUsersListRolesCmd() { - UsersListRolesCmd.Flags().StringVar(&UsersListRolesCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersListRolesCmd.Flags().StringVar(&UsersListRolesCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) - UsersListRolesCmd.Flags().StringVar(&UsersListRolesCmdUserName, "user-name", "", TRAPI("user_name")) + UsersListRolesCmd.Flags().StringVar(&UsersListRolesCmdUserName, "user-name", "", TRAPI("SAM user name.")) UsersListRolesCmd.Flags().BoolVar(&UsersListRolesCmdOutputJSONL, "jsonl", false, TRCLI("cli.common_params.jsonl.short_help")) diff --git a/soracom/generated/cmd/users_trust_policy_delete.go b/soracom/generated/cmd/users_trust_policy_delete.go index a29499c4..9445e195 100644 --- a/soracom/generated/cmd/users_trust_policy_delete.go +++ b/soracom/generated/cmd/users_trust_policy_delete.go @@ -16,7 +16,7 @@ var UsersTrustPolicyDeleteCmdOperatorId string var UsersTrustPolicyDeleteCmdUserName string func InitUsersTrustPolicyDeleteCmd() { - UsersTrustPolicyDeleteCmd.Flags().StringVar(&UsersTrustPolicyDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersTrustPolicyDeleteCmd.Flags().StringVar(&UsersTrustPolicyDeleteCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) UsersTrustPolicyDeleteCmd.Flags().StringVar(&UsersTrustPolicyDeleteCmdUserName, "user-name", "", TRAPI("SAM user name.")) diff --git a/soracom/generated/cmd/users_trust_policy_get.go b/soracom/generated/cmd/users_trust_policy_get.go index 4f3e6465..f24e328c 100644 --- a/soracom/generated/cmd/users_trust_policy_get.go +++ b/soracom/generated/cmd/users_trust_policy_get.go @@ -16,7 +16,7 @@ var UsersTrustPolicyGetCmdOperatorId string var UsersTrustPolicyGetCmdUserName string func InitUsersTrustPolicyGetCmd() { - UsersTrustPolicyGetCmd.Flags().StringVar(&UsersTrustPolicyGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersTrustPolicyGetCmd.Flags().StringVar(&UsersTrustPolicyGetCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) UsersTrustPolicyGetCmd.Flags().StringVar(&UsersTrustPolicyGetCmdUserName, "user-name", "", TRAPI("SAM user name.")) diff --git a/soracom/generated/cmd/users_trust_policy_update.go b/soracom/generated/cmd/users_trust_policy_update.go index fd659b77..6aec1405 100644 --- a/soracom/generated/cmd/users_trust_policy_update.go +++ b/soracom/generated/cmd/users_trust_policy_update.go @@ -26,7 +26,7 @@ var UsersTrustPolicyUpdateCmdUserName string var UsersTrustPolicyUpdateCmdBody string func InitUsersTrustPolicyUpdateCmd() { - UsersTrustPolicyUpdateCmd.Flags().StringVar(&UsersTrustPolicyUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID")) + UsersTrustPolicyUpdateCmd.Flags().StringVar(&UsersTrustPolicyUpdateCmdOperatorId, "operator-id", "", TRAPI("Operator ID.")) UsersTrustPolicyUpdateCmd.Flags().StringVar(&UsersTrustPolicyUpdateCmdTrustPolicy, "trust-policy", "", TRAPI("Trust policy that describes who can switch to this user.")) diff --git a/soracom/generated/cmd/volume_discounts_confirm.go b/soracom/generated/cmd/volume_discounts_confirm.go index 4c2d54e8..34711273 100644 --- a/soracom/generated/cmd/volume_discounts_confirm.go +++ b/soracom/generated/cmd/volume_discounts_confirm.go @@ -13,7 +13,7 @@ import ( var VolumeDiscountsConfirmCmdOrderId string func InitVolumeDiscountsConfirmCmd() { - VolumeDiscountsConfirmCmd.Flags().StringVar(&VolumeDiscountsConfirmCmdOrderId, "order-id", "", TRAPI("Order ID")) + VolumeDiscountsConfirmCmd.Flags().StringVar(&VolumeDiscountsConfirmCmdOrderId, "order-id", "", TRAPI("Order ID.")) VolumeDiscountsConfirmCmd.RunE = VolumeDiscountsConfirmCmdRunE diff --git a/soracom/generated/cmd/volume_discounts_create.go b/soracom/generated/cmd/volume_discounts_create.go index 28d4fb37..1b7fc15f 100644 --- a/soracom/generated/cmd/volume_discounts_create.go +++ b/soracom/generated/cmd/volume_discounts_create.go @@ -32,15 +32,15 @@ var VolumeDiscountsCreateCmdQuantity int64 var VolumeDiscountsCreateCmdBody string func InitVolumeDiscountsCreateCmd() { - VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdStartDate, "start-date", "", TRAPI("Start date")) + VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdStartDate, "start-date", "", TRAPI("Start date.")) - VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdVolumeDiscountPaymentType, "volume-discount-payment-type", "", TRAPI("Payment type")) + VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdVolumeDiscountPaymentType, "volume-discount-payment-type", "", TRAPI("Payment type.")) - VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdVolumeDiscountType, "volume-discount-type", "", TRAPI("Long term discount type")) + VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdVolumeDiscountType, "volume-discount-type", "", TRAPI("Long term discount type.")) - VolumeDiscountsCreateCmd.Flags().Int64Var(&VolumeDiscountsCreateCmdContractTermMonth, "contract-term-month", 12, TRAPI("Contract months")) + VolumeDiscountsCreateCmd.Flags().Int64Var(&VolumeDiscountsCreateCmdContractTermMonth, "contract-term-month", 12, TRAPI("Contract months.")) - VolumeDiscountsCreateCmd.Flags().Int64Var(&VolumeDiscountsCreateCmdQuantity, "quantity", 0, TRAPI("Quantity")) + VolumeDiscountsCreateCmd.Flags().Int64Var(&VolumeDiscountsCreateCmdQuantity, "quantity", 0, TRAPI("Quantity.")) VolumeDiscountsCreateCmd.Flags().StringVar(&VolumeDiscountsCreateCmdBody, "body", "", TRCLI("cli.common_params.body.short_help")) diff --git a/soracom/generated/cmd/volume_discounts_get.go b/soracom/generated/cmd/volume_discounts_get.go index 46a27a58..5511180d 100644 --- a/soracom/generated/cmd/volume_discounts_get.go +++ b/soracom/generated/cmd/volume_discounts_get.go @@ -13,7 +13,7 @@ import ( var VolumeDiscountsGetCmdContractId string func InitVolumeDiscountsGetCmd() { - VolumeDiscountsGetCmd.Flags().StringVar(&VolumeDiscountsGetCmdContractId, "contract-id", "", TRAPI("contract_id")) + VolumeDiscountsGetCmd.Flags().StringVar(&VolumeDiscountsGetCmdContractId, "contract-id", "", TRAPI("Contract ID.")) VolumeDiscountsGetCmd.RunE = VolumeDiscountsGetCmdRunE diff --git a/soracom/generated/cmd/vpg_disable_sim_based_routing.go b/soracom/generated/cmd/vpg_disable_sim_based_routing.go index 16dcfcd0..3ba5a55c 100644 --- a/soracom/generated/cmd/vpg_disable_sim_based_routing.go +++ b/soracom/generated/cmd/vpg_disable_sim_based_routing.go @@ -24,7 +24,7 @@ func InitVpgDisableSimBasedRoutingCmd() { var VpgDisableSimBasedRoutingCmd = &cobra.Command{ Use: "disable-sim-based-routing", Short: TRAPI("/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable:post:summary"), - Long: TRAPI(`/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable:post:description`) + "\n\n" + createLinkToAPIReference("VirtualPrivateGateway", "disableSimBasedRouging"), + Long: TRAPI(`/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable:post:description`) + "\n\n" + createLinkToAPIReference("VirtualPrivateGateway", "disableSimBasedRouting"), } func VpgDisableSimBasedRoutingCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/vpg_enable_sim_based_routing.go b/soracom/generated/cmd/vpg_enable_sim_based_routing.go index 06e0ef57..e72cbd6d 100644 --- a/soracom/generated/cmd/vpg_enable_sim_based_routing.go +++ b/soracom/generated/cmd/vpg_enable_sim_based_routing.go @@ -24,7 +24,7 @@ func InitVpgEnableSimBasedRoutingCmd() { var VpgEnableSimBasedRoutingCmd = &cobra.Command{ Use: "enable-sim-based-routing", Short: TRAPI("/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable:post:summary"), - Long: TRAPI(`/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable:post:description`) + "\n\n" + createLinkToAPIReference("VirtualPrivateGateway", "enableSimBasedRouging"), + Long: TRAPI(`/virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable:post:description`) + "\n\n" + createLinkToAPIReference("VirtualPrivateGateway", "enableSimBasedRouting"), } func VpgEnableSimBasedRoutingCmdRunE(cmd *cobra.Command, args []string) error { diff --git a/soracom/generated/cmd/vpg_list_packet_capture_sessions.go b/soracom/generated/cmd/vpg_list_packet_capture_sessions.go index 1e9ca273..9053dfa4 100644 --- a/soracom/generated/cmd/vpg_list_packet_capture_sessions.go +++ b/soracom/generated/cmd/vpg_list_packet_capture_sessions.go @@ -29,7 +29,7 @@ func InitVpgListPacketCaptureSessionsCmd() { VpgListPacketCaptureSessionsCmd.Flags().StringVar(&VpgListPacketCaptureSessionsCmdVpgId, "vpg-id", "", TRAPI("VPG ID")) - VpgListPacketCaptureSessionsCmd.Flags().Int64Var(&VpgListPacketCaptureSessionsCmdLimit, "limit", 10, TRAPI("Max number of results in a response")) + VpgListPacketCaptureSessionsCmd.Flags().Int64Var(&VpgListPacketCaptureSessionsCmdLimit, "limit", 10, TRAPI("Max number of results in a response.")) VpgListPacketCaptureSessionsCmd.Flags().BoolVar(&VpgListPacketCaptureSessionsCmdPaginate, "fetch-all", false, TRCLI("cli.common_params.paginate.short_help")) diff --git a/test/data/help_ja_expected.txt b/test/data/help_ja_expected.txt index 7dac884f..b13f71c0 100644 --- a/test/data/help_ja_expected.txt +++ b/test/data/help_ja_expected.txt @@ -9,8 +9,8 @@ Available Commands: bills 課金に関する情報を確認したりファイルへのエクスポートを行います。 cell-locations 基地局の位置情報を取得します。 completion bash もしくは zsh 用の補完 (completion) スクリプトを生成します。 - configure コマンド実行環境（プロファイル）の設定や表示を行います。 - configure-sandbox API Sandbox 用のコマンド実行環境（プロファイル）の設定を行います。 + configure コマンド実行環境 (プロファイル) の設定や表示を行います。 + configure-sandbox API Sandbox 用のコマンド実行環境 (プロファイル) の設定を行います。 coupons 登録済みクーポンを確認したりアカウントへのクーポン登録を行います。 credentials 認証情報に関する操作を行います。 data SIM からアップロードされて格納されているデータを取得します。 @@ -36,7 +36,7 @@ Available Commands: payment-statements 課金明細の一覧取得または出力を行います。 port-mappings オンデマンドリモートアクセスのためのポートマッピング設定を管理します。 products 商品一覧を取得します。 - query リソース（サブスクライバー、Sigfox デバイス）をいろいろな条件で検索します。 + query リソース (サブスクライバー、Sigfox デバイス) をいろいろな条件で検索します。 resource-summaries リソースの要約を取得します。 roles ロールに関する操作を行います。 sandbox API サンドボックスに関する操作を行います。 @@ -46,13 +46,13 @@ Available Commands: sims SIM に関する操作を行います。 sora-cam Soracom Cloud Camera Services (ソラカメ) に関する操作を行います。 soralets Orbit の Soralet に関する操作を行います。 - stats 統計情報に関する操作を行います。 + stats 統計情報 (利用量履歴) に関する操作をする subscribers サブスクライバー (SIM) に関する操作を行います。 system-notifications システム通知に関する操作を行います。 - unconfigure コマンド実行環境（プロファイル）を削除します。 + unconfigure コマンド実行環境 (プロファイル) を削除します。 users SAM ユーザーに関する操作を行います。 version バージョン情報を表示します。 - volume-discounts ボリュームディスカウント（長期利用割引）に関する操作を行います。 + volume-discounts ボリュームディスカウント (長期利用割引) に関する操作を行います。 vpg VPG に関する操作を行います。 Flags: @@ -79,7 +79,7 @@ Flags: --coverage-type string カバレッジタイプを指定します。グローバルカバレッジは 'g'、日本カバレッジは 'jp' です。 -h, --help help for soracom - --no-retry-on-error このフラグを指定すると、API がエラーを返してきた場合にもリトライしません（デフォルトではバックオフしながら数回リトライします）。 + --no-retry-on-error このフラグを指定すると、API がエラーを返してきた場合にもリトライしません (デフォルトではバックオフしながら数回リトライします)。 --profile string プロファイル名を指定します。 @@ -88,6 +88,6 @@ Flags: すなわち事前に 'soracom configure' コマンドを実行しておく必要がなくなります。 認証情報をパスワードマネージャーなどのより安全な場所に格納しておき、外部コマンド経由でそれを利用することができます。 - --raw-output API から返却されたレスポンスを加工せずにそのまま出力します（デフォルトでは JSON をインデントして表示します）。 + --raw-output API から返却されたレスポンスを加工せずにそのまま出力します (デフォルトでは JSON をインデントして表示します)。 Use "soracom [command] --help" for more information about a command.