github.com/optim-corp/cios-golang-sdk@v0.5.1/cios/docs/GeographyApi.md (about) 1 # \GeographyApi 2 3 All URIs are relative to *http://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateCircle**](GeographyApi.md#CreateCircle) | **Post** /v2/geo/circles | 8 [**CreatePoint**](GeographyApi.md#CreatePoint) | **Post** /v2/geo/points | 9 [**CreateRoute**](GeographyApi.md#CreateRoute) | **Post** /v2/geo/routes | 10 [**DeleteCircle**](GeographyApi.md#DeleteCircle) | **Delete** /v2/geo/circles/{circles_id} | 11 [**DeletePoint**](GeographyApi.md#DeletePoint) | **Delete** /v2/geo/points/{point_id} | 12 [**DeleteRoute**](GeographyApi.md#DeleteRoute) | **Delete** /v2/geo/routes/{routes_id} | 13 [**GetCircle**](GeographyApi.md#GetCircle) | **Get** /v2/geo/circles/{circles_id} | 14 [**GetCircles**](GeographyApi.md#GetCircles) | **Get** /v2/geo/circles | 15 [**GetPoint**](GeographyApi.md#GetPoint) | **Get** /v2/geo/points/{point_id} | 16 [**GetPoints**](GeographyApi.md#GetPoints) | **Get** /v2/geo/points | 17 [**GetRoute**](GeographyApi.md#GetRoute) | **Get** /v2/geo/routes/{routes_id} | 18 [**GetRoutes**](GeographyApi.md#GetRoutes) | **Get** /v2/geo/routes | 19 [**UpdateCircle**](GeographyApi.md#UpdateCircle) | **Patch** /v2/geo/circles/{circles_id} | 20 [**UpdatePoint**](GeographyApi.md#UpdatePoint) | **Patch** /v2/geo/points/{point_id} | 21 [**UpdateRoute**](GeographyApi.md#UpdateRoute) | **Patch** /v2/geo/routes/{routes_id} | 22 23 24 25 ## CreateCircle 26 27 > SingleCircle CreateCircle(ctx).Circle(circle).Execute() 28 29 30 31 ### Example 32 33 ```go 34 package main 35 36 import ( 37 "context" 38 "fmt" 39 "os" 40 openapiclient "./openapi" 41 ) 42 43 func main() { 44 circle := *openapiclient.NewCircle() // Circle | 45 46 configuration := openapiclient.NewConfiguration() 47 api_client := openapiclient.NewAPIClient(configuration) 48 resp, r, err := api_client.GeographyApi.CreateCircle(context.Background()).Circle(circle).Execute() 49 if err.Error() != "" { 50 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.CreateCircle``: %v\n", err) 51 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 52 } 53 // response from `CreateCircle`: SingleCircle 54 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.CreateCircle`: %v\n", resp) 55 } 56 ``` 57 58 ### Path Parameters 59 60 61 62 ### Other Parameters 63 64 Other parameters are passed through a pointer to a apiCreateCircleRequest struct via the builder pattern 65 66 67 Name | Type | Description | Notes 68 ------------- | ------------- | ------------- | ------------- 69 **circle** | [**Circle**](Circle.md) | | 70 71 ### Return type 72 73 [**SingleCircle**](SingleCircle.md) 74 75 ### Authorization 76 77 [bearerAuth](../README.md#bearerAuth) 78 79 ### HTTP request headers 80 81 - **Content-Type**: application/json 82 - **Accept**: application/json 83 84 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 85 [[Back to Model list]](../README.md#documentation-for-models) 86 [[Back to README]](../README.md) 87 88 89 ## CreatePoint 90 91 > SinglePoint CreatePoint(ctx).PointRequest(pointRequest).Execute() 92 93 94 95 ### Example 96 97 ```go 98 package main 99 100 import ( 101 "context" 102 "fmt" 103 "os" 104 openapiclient "./openapi" 105 ) 106 107 func main() { 108 pointRequest := *openapiclient.NewPointRequest("ResourceOwnerId_example") // PointRequest | 109 110 configuration := openapiclient.NewConfiguration() 111 api_client := openapiclient.NewAPIClient(configuration) 112 resp, r, err := api_client.GeographyApi.CreatePoint(context.Background()).PointRequest(pointRequest).Execute() 113 if err.Error() != "" { 114 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.CreatePoint``: %v\n", err) 115 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 116 } 117 // response from `CreatePoint`: SinglePoint 118 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.CreatePoint`: %v\n", resp) 119 } 120 ``` 121 122 ### Path Parameters 123 124 125 126 ### Other Parameters 127 128 Other parameters are passed through a pointer to a apiCreatePointRequest struct via the builder pattern 129 130 131 Name | Type | Description | Notes 132 ------------- | ------------- | ------------- | ------------- 133 **pointRequest** | [**PointRequest**](PointRequest.md) | | 134 135 ### Return type 136 137 [**SinglePoint**](SinglePoint.md) 138 139 ### Authorization 140 141 [bearerAuth](../README.md#bearerAuth) 142 143 ### HTTP request headers 144 145 - **Content-Type**: application/json 146 - **Accept**: application/json 147 148 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 149 [[Back to Model list]](../README.md#documentation-for-models) 150 [[Back to README]](../README.md) 151 152 153 ## CreateRoute 154 155 > SingleRoute CreateRoute(ctx).Route(route).Execute() 156 157 158 159 ### Example 160 161 ```go 162 package main 163 164 import ( 165 "context" 166 "fmt" 167 "os" 168 openapiclient "./openapi" 169 ) 170 171 func main() { 172 route := *openapiclient.NewRoute() // Route | 173 174 configuration := openapiclient.NewConfiguration() 175 api_client := openapiclient.NewAPIClient(configuration) 176 resp, r, err := api_client.GeographyApi.CreateRoute(context.Background()).Route(route).Execute() 177 if err.Error() != "" { 178 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.CreateRoute``: %v\n", err) 179 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 180 } 181 // response from `CreateRoute`: SingleRoute 182 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.CreateRoute`: %v\n", resp) 183 } 184 ``` 185 186 ### Path Parameters 187 188 189 190 ### Other Parameters 191 192 Other parameters are passed through a pointer to a apiCreateRouteRequest struct via the builder pattern 193 194 195 Name | Type | Description | Notes 196 ------------- | ------------- | ------------- | ------------- 197 **route** | [**Route**](Route.md) | | 198 199 ### Return type 200 201 [**SingleRoute**](SingleRoute.md) 202 203 ### Authorization 204 205 [bearerAuth](../README.md#bearerAuth) 206 207 ### HTTP request headers 208 209 - **Content-Type**: application/json 210 - **Accept**: application/json 211 212 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 213 [[Back to Model list]](../README.md#documentation-for-models) 214 [[Back to README]](../README.md) 215 216 217 ## DeleteCircle 218 219 > DeleteCircle(ctx, circleId).Execute() 220 221 222 223 ### Example 224 225 ```go 226 package main 227 228 import ( 229 "context" 230 "fmt" 231 "os" 232 openapiclient "./openapi" 233 ) 234 235 func main() { 236 circleId := "circleId_example" // string | 237 238 configuration := openapiclient.NewConfiguration() 239 api_client := openapiclient.NewAPIClient(configuration) 240 resp, r, err := api_client.GeographyApi.DeleteCircle(context.Background(), circleId).Execute() 241 if err.Error() != "" { 242 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.DeleteCircle``: %v\n", err) 243 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 244 } 245 } 246 ``` 247 248 ### Path Parameters 249 250 251 Name | Type | Description | Notes 252 ------------- | ------------- | ------------- | ------------- 253 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 254 **circleId** | **string** | | 255 256 ### Other Parameters 257 258 Other parameters are passed through a pointer to a apiDeleteCircleRequest struct via the builder pattern 259 260 261 Name | Type | Description | Notes 262 ------------- | ------------- | ------------- | ------------- 263 264 265 ### Return type 266 267 (empty response body) 268 269 ### Authorization 270 271 [bearerAuth](../README.md#bearerAuth) 272 273 ### HTTP request headers 274 275 - **Content-Type**: Not defined 276 - **Accept**: Not defined 277 278 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 279 [[Back to Model list]](../README.md#documentation-for-models) 280 [[Back to README]](../README.md) 281 282 283 ## DeletePoint 284 285 > SinglePoint DeletePoint(ctx, pointId).Execute() 286 287 288 289 ### Example 290 291 ```go 292 package main 293 294 import ( 295 "context" 296 "fmt" 297 "os" 298 openapiclient "./openapi" 299 ) 300 301 func main() { 302 pointId := "pointId_example" // string | 303 304 configuration := openapiclient.NewConfiguration() 305 api_client := openapiclient.NewAPIClient(configuration) 306 resp, r, err := api_client.GeographyApi.DeletePoint(context.Background(), pointId).Execute() 307 if err.Error() != "" { 308 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.DeletePoint``: %v\n", err) 309 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 310 } 311 // response from `DeletePoint`: SinglePoint 312 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.DeletePoint`: %v\n", resp) 313 } 314 ``` 315 316 ### Path Parameters 317 318 319 Name | Type | Description | Notes 320 ------------- | ------------- | ------------- | ------------- 321 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 322 **pointId** | **string** | | 323 324 ### Other Parameters 325 326 Other parameters are passed through a pointer to a apiDeletePointRequest struct via the builder pattern 327 328 329 Name | Type | Description | Notes 330 ------------- | ------------- | ------------- | ------------- 331 332 333 ### Return type 334 335 [**SinglePoint**](SinglePoint.md) 336 337 ### Authorization 338 339 [bearerAuth](../README.md#bearerAuth) 340 341 ### HTTP request headers 342 343 - **Content-Type**: Not defined 344 - **Accept**: application/json 345 346 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 347 [[Back to Model list]](../README.md#documentation-for-models) 348 [[Back to README]](../README.md) 349 350 351 ## DeleteRoute 352 353 > DeleteRoute(ctx, routeId).Execute() 354 355 356 357 ### Example 358 359 ```go 360 package main 361 362 import ( 363 "context" 364 "fmt" 365 "os" 366 openapiclient "./openapi" 367 ) 368 369 func main() { 370 routeId := "routeId_example" // string | 371 372 configuration := openapiclient.NewConfiguration() 373 api_client := openapiclient.NewAPIClient(configuration) 374 resp, r, err := api_client.GeographyApi.DeleteRoute(context.Background(), routeId).Execute() 375 if err.Error() != "" { 376 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.DeleteRoute``: %v\n", err) 377 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 378 } 379 } 380 ``` 381 382 ### Path Parameters 383 384 385 Name | Type | Description | Notes 386 ------------- | ------------- | ------------- | ------------- 387 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 388 **routeId** | **string** | | 389 390 ### Other Parameters 391 392 Other parameters are passed through a pointer to a apiDeleteRouteRequest struct via the builder pattern 393 394 395 Name | Type | Description | Notes 396 ------------- | ------------- | ------------- | ------------- 397 398 399 ### Return type 400 401 (empty response body) 402 403 ### Authorization 404 405 [bearerAuth](../README.md#bearerAuth) 406 407 ### HTTP request headers 408 409 - **Content-Type**: Not defined 410 - **Accept**: Not defined 411 412 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 413 [[Back to Model list]](../README.md#documentation-for-models) 414 [[Back to README]](../README.md) 415 416 417 ## GetCircle 418 419 > SingleCircle GetCircle(ctx, circleId).Lang(lang).IsDev(isDev).Execute() 420 421 422 423 ### Example 424 425 ```go 426 package main 427 428 import ( 429 "context" 430 "fmt" 431 "os" 432 openapiclient "./openapi" 433 ) 434 435 func main() { 436 circleId := "circleId_example" // string | 437 lang := "lang_example" // string | 言語指定 (optional) 438 isDev := true // bool | 開発者モードの有効・無効 (optional) 439 440 configuration := openapiclient.NewConfiguration() 441 api_client := openapiclient.NewAPIClient(configuration) 442 resp, r, err := api_client.GeographyApi.GetCircle(context.Background(), circleId).Lang(lang).IsDev(isDev).Execute() 443 if err.Error() != "" { 444 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetCircle``: %v\n", err) 445 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 446 } 447 // response from `GetCircle`: SingleCircle 448 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetCircle`: %v\n", resp) 449 } 450 ``` 451 452 ### Path Parameters 453 454 455 Name | Type | Description | Notes 456 ------------- | ------------- | ------------- | ------------- 457 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 458 **circleId** | **string** | | 459 460 ### Other Parameters 461 462 Other parameters are passed through a pointer to a apiGetCircleRequest struct via the builder pattern 463 464 465 Name | Type | Description | Notes 466 ------------- | ------------- | ------------- | ------------- 467 468 **lang** | **string** | 言語指定 | 469 **isDev** | **bool** | 開発者モードの有効・無効 | 470 471 ### Return type 472 473 [**SingleCircle**](SingleCircle.md) 474 475 ### Authorization 476 477 [bearerAuth](../README.md#bearerAuth) 478 479 ### HTTP request headers 480 481 - **Content-Type**: Not defined 482 - **Accept**: application/json 483 484 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 485 [[Back to Model list]](../README.md#documentation-for-models) 486 [[Back to README]](../README.md) 487 488 489 ## GetCircles 490 491 > MultipleCircle GetCircles(ctx).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 492 493 494 495 ### Example 496 497 ```go 498 package main 499 500 import ( 501 "context" 502 "fmt" 503 "os" 504 openapiclient "./openapi" 505 ) 506 507 func main() { 508 name := "name_example" // string | 名前での部分一致検索 (optional) 509 label := "label_example" // string | (optional) 510 isPublic := "isPublic_example" // string | デバイスの公開・非公開 (optional) 511 resourceOwnerId := TODO // string | (optional) 512 sort := "sort_example" // string | (optional) 513 top := int32(56) // int32 | (optional) 514 skip := int32(56) // int32 | (optional) 515 lang := "lang_example" // string | 言語指定 (optional) 516 isDev := true // bool | 開発者モードの有効・無効 (optional) 517 518 configuration := openapiclient.NewConfiguration() 519 api_client := openapiclient.NewAPIClient(configuration) 520 resp, r, err := api_client.GeographyApi.GetCircles(context.Background()).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 521 if err.Error() != "" { 522 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetCircles``: %v\n", err) 523 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 524 } 525 // response from `GetCircles`: MultipleCircle 526 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetCircles`: %v\n", resp) 527 } 528 ``` 529 530 ### Path Parameters 531 532 533 534 ### Other Parameters 535 536 Other parameters are passed through a pointer to a apiGetCirclesRequest struct via the builder pattern 537 538 539 Name | Type | Description | Notes 540 ------------- | ------------- | ------------- | ------------- 541 **name** | **string** | 名前での部分一致検索 | 542 **label** | **string** | | 543 **isPublic** | **string** | デバイスの公開・非公開 | 544 **resourceOwnerId** | [**string**](string.md) | | 545 **sort** | **string** | | 546 **top** | **int32** | | 547 **skip** | **int32** | | 548 **lang** | **string** | 言語指定 | 549 **isDev** | **bool** | 開発者モードの有効・無効 | 550 551 ### Return type 552 553 [**MultipleCircle**](MultipleCircle.md) 554 555 ### Authorization 556 557 [bearerAuth](../README.md#bearerAuth) 558 559 ### HTTP request headers 560 561 - **Content-Type**: Not defined 562 - **Accept**: application/json 563 564 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 565 [[Back to Model list]](../README.md#documentation-for-models) 566 [[Back to README]](../README.md) 567 568 569 ## GetPoint 570 571 > SinglePoint GetPoint(ctx, pointId).Lang(lang).IsDev(isDev).Execute() 572 573 574 575 ### Example 576 577 ```go 578 package main 579 580 import ( 581 "context" 582 "fmt" 583 "os" 584 openapiclient "./openapi" 585 ) 586 587 func main() { 588 pointId := "pointId_example" // string | 589 lang := "lang_example" // string | 言語指定 (optional) 590 isDev := true // bool | 開発者モードの有効・無効 (optional) 591 592 configuration := openapiclient.NewConfiguration() 593 api_client := openapiclient.NewAPIClient(configuration) 594 resp, r, err := api_client.GeographyApi.GetPoint(context.Background(), pointId).Lang(lang).IsDev(isDev).Execute() 595 if err.Error() != "" { 596 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetPoint``: %v\n", err) 597 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 598 } 599 // response from `GetPoint`: SinglePoint 600 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetPoint`: %v\n", resp) 601 } 602 ``` 603 604 ### Path Parameters 605 606 607 Name | Type | Description | Notes 608 ------------- | ------------- | ------------- | ------------- 609 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 610 **pointId** | **string** | | 611 612 ### Other Parameters 613 614 Other parameters are passed through a pointer to a apiGetPointRequest struct via the builder pattern 615 616 617 Name | Type | Description | Notes 618 ------------- | ------------- | ------------- | ------------- 619 620 **lang** | **string** | 言語指定 | 621 **isDev** | **bool** | 開発者モードの有効・無効 | 622 623 ### Return type 624 625 [**SinglePoint**](SinglePoint.md) 626 627 ### Authorization 628 629 [bearerAuth](../README.md#bearerAuth) 630 631 ### HTTP request headers 632 633 - **Content-Type**: Not defined 634 - **Accept**: application/json 635 636 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 637 [[Back to Model list]](../README.md#documentation-for-models) 638 [[Back to README]](../README.md) 639 640 641 ## GetPoints 642 643 > MultiplePoint GetPoints(ctx).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 644 645 646 647 ### Example 648 649 ```go 650 package main 651 652 import ( 653 "context" 654 "fmt" 655 "os" 656 openapiclient "./openapi" 657 ) 658 659 func main() { 660 name := "name_example" // string | 名前での部分一致検索 (optional) 661 label := "label_example" // string | (optional) 662 isPublic := "isPublic_example" // string | デバイスの公開・非公開 (optional) 663 resourceOwnerId := TODO // string | (optional) 664 sort := "sort_example" // string | (optional) 665 top := int32(56) // int32 | (optional) 666 skip := int32(56) // int32 | (optional) 667 lang := "lang_example" // string | 言語指定 (optional) 668 isDev := true // bool | 開発者モードの有効・無効 (optional) 669 670 configuration := openapiclient.NewConfiguration() 671 api_client := openapiclient.NewAPIClient(configuration) 672 resp, r, err := api_client.GeographyApi.GetPoints(context.Background()).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 673 if err.Error() != "" { 674 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetPoints``: %v\n", err) 675 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 676 } 677 // response from `GetPoints`: MultiplePoint 678 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetPoints`: %v\n", resp) 679 } 680 ``` 681 682 ### Path Parameters 683 684 685 686 ### Other Parameters 687 688 Other parameters are passed through a pointer to a apiGetPointsRequest struct via the builder pattern 689 690 691 Name | Type | Description | Notes 692 ------------- | ------------- | ------------- | ------------- 693 **name** | **string** | 名前での部分一致検索 | 694 **label** | **string** | | 695 **isPublic** | **string** | デバイスの公開・非公開 | 696 **resourceOwnerId** | [**string**](string.md) | | 697 **sort** | **string** | | 698 **top** | **int32** | | 699 **skip** | **int32** | | 700 **lang** | **string** | 言語指定 | 701 **isDev** | **bool** | 開発者モードの有効・無効 | 702 703 ### Return type 704 705 [**MultiplePoint**](MultiplePoint.md) 706 707 ### Authorization 708 709 [bearerAuth](../README.md#bearerAuth) 710 711 ### HTTP request headers 712 713 - **Content-Type**: Not defined 714 - **Accept**: application/json 715 716 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 717 [[Back to Model list]](../README.md#documentation-for-models) 718 [[Back to README]](../README.md) 719 720 721 ## GetRoute 722 723 > SingleRoute GetRoute(ctx, routeId).Lang(lang).IsDev(isDev).Execute() 724 725 726 727 ### Example 728 729 ```go 730 package main 731 732 import ( 733 "context" 734 "fmt" 735 "os" 736 openapiclient "./openapi" 737 ) 738 739 func main() { 740 routeId := "routeId_example" // string | 741 lang := "lang_example" // string | 言語指定 (optional) 742 isDev := true // bool | 開発者モードの有効・無効 (optional) 743 744 configuration := openapiclient.NewConfiguration() 745 api_client := openapiclient.NewAPIClient(configuration) 746 resp, r, err := api_client.GeographyApi.GetRoute(context.Background(), routeId).Lang(lang).IsDev(isDev).Execute() 747 if err.Error() != "" { 748 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetRoute``: %v\n", err) 749 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 750 } 751 // response from `GetRoute`: SingleRoute 752 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetRoute`: %v\n", resp) 753 } 754 ``` 755 756 ### Path Parameters 757 758 759 Name | Type | Description | Notes 760 ------------- | ------------- | ------------- | ------------- 761 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 762 **routeId** | **string** | | 763 764 ### Other Parameters 765 766 Other parameters are passed through a pointer to a apiGetRouteRequest struct via the builder pattern 767 768 769 Name | Type | Description | Notes 770 ------------- | ------------- | ------------- | ------------- 771 772 **lang** | **string** | 言語指定 | 773 **isDev** | **bool** | 開発者モードの有効・無効 | 774 775 ### Return type 776 777 [**SingleRoute**](SingleRoute.md) 778 779 ### Authorization 780 781 [bearerAuth](../README.md#bearerAuth) 782 783 ### HTTP request headers 784 785 - **Content-Type**: Not defined 786 - **Accept**: application/json 787 788 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 789 [[Back to Model list]](../README.md#documentation-for-models) 790 [[Back to README]](../README.md) 791 792 793 ## GetRoutes 794 795 > MultipleRoute GetRoutes(ctx).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 796 797 798 799 ### Example 800 801 ```go 802 package main 803 804 import ( 805 "context" 806 "fmt" 807 "os" 808 openapiclient "./openapi" 809 ) 810 811 func main() { 812 name := "name_example" // string | 名前での部分一致検索 (optional) 813 label := "label_example" // string | (optional) 814 isPublic := "isPublic_example" // string | デバイスの公開・非公開 (optional) 815 resourceOwnerId := TODO // string | (optional) 816 sort := "sort_example" // string | (optional) 817 top := int32(56) // int32 | (optional) 818 skip := int32(56) // int32 | (optional) 819 lang := "lang_example" // string | 言語指定 (optional) 820 isDev := true // bool | 開発者モードの有効・無効 (optional) 821 822 configuration := openapiclient.NewConfiguration() 823 api_client := openapiclient.NewAPIClient(configuration) 824 resp, r, err := api_client.GeographyApi.GetRoutes(context.Background()).Name(name).Label(label).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Sort(sort).Top(top).Skip(skip).Lang(lang).IsDev(isDev).Execute() 825 if err.Error() != "" { 826 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.GetRoutes``: %v\n", err) 827 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 828 } 829 // response from `GetRoutes`: MultipleRoute 830 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.GetRoutes`: %v\n", resp) 831 } 832 ``` 833 834 ### Path Parameters 835 836 837 838 ### Other Parameters 839 840 Other parameters are passed through a pointer to a apiGetRoutesRequest struct via the builder pattern 841 842 843 Name | Type | Description | Notes 844 ------------- | ------------- | ------------- | ------------- 845 **name** | **string** | 名前での部分一致検索 | 846 **label** | **string** | | 847 **isPublic** | **string** | デバイスの公開・非公開 | 848 **resourceOwnerId** | [**string**](string.md) | | 849 **sort** | **string** | | 850 **top** | **int32** | | 851 **skip** | **int32** | | 852 **lang** | **string** | 言語指定 | 853 **isDev** | **bool** | 開発者モードの有効・無効 | 854 855 ### Return type 856 857 [**MultipleRoute**](MultipleRoute.md) 858 859 ### Authorization 860 861 [bearerAuth](../README.md#bearerAuth) 862 863 ### HTTP request headers 864 865 - **Content-Type**: Not defined 866 - **Accept**: application/json 867 868 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 869 [[Back to Model list]](../README.md#documentation-for-models) 870 [[Back to README]](../README.md) 871 872 873 ## UpdateCircle 874 875 > SingleCircle UpdateCircle(ctx, circleId).DisplayInfo(displayInfo).Execute() 876 877 878 879 ### Example 880 881 ```go 882 package main 883 884 import ( 885 "context" 886 "fmt" 887 "os" 888 openapiclient "./openapi" 889 ) 890 891 func main() { 892 circleId := "circleId_example" // string | 893 displayInfo := []openapiclient.DisplayInfo{*openapiclient.NewDisplayInfo("Name_example", "Language_example", false)} // []DisplayInfo | (optional) 894 895 configuration := openapiclient.NewConfiguration() 896 api_client := openapiclient.NewAPIClient(configuration) 897 resp, r, err := api_client.GeographyApi.UpdateCircle(context.Background(), circleId).DisplayInfo(displayInfo).Execute() 898 if err.Error() != "" { 899 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.UpdateCircle``: %v\n", err) 900 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 901 } 902 // response from `UpdateCircle`: SingleCircle 903 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.UpdateCircle`: %v\n", resp) 904 } 905 ``` 906 907 ### Path Parameters 908 909 910 Name | Type | Description | Notes 911 ------------- | ------------- | ------------- | ------------- 912 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 913 **circleId** | **string** | | 914 915 ### Other Parameters 916 917 Other parameters are passed through a pointer to a apiUpdateCircleRequest struct via the builder pattern 918 919 920 Name | Type | Description | Notes 921 ------------- | ------------- | ------------- | ------------- 922 923 **displayInfo** | [**[]DisplayInfo**](DisplayInfo.md) | | 924 925 ### Return type 926 927 [**SingleCircle**](SingleCircle.md) 928 929 ### Authorization 930 931 [bearerAuth](../README.md#bearerAuth) 932 933 ### HTTP request headers 934 935 - **Content-Type**: application/json 936 - **Accept**: application/json 937 938 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 939 [[Back to Model list]](../README.md#documentation-for-models) 940 [[Back to README]](../README.md) 941 942 943 ## UpdatePoint 944 945 > SinglePoint UpdatePoint(ctx, pointId).DisplayInfo(displayInfo).Execute() 946 947 948 949 ### Example 950 951 ```go 952 package main 953 954 import ( 955 "context" 956 "fmt" 957 "os" 958 openapiclient "./openapi" 959 ) 960 961 func main() { 962 pointId := "pointId_example" // string | 963 displayInfo := []openapiclient.DisplayInfo{*openapiclient.NewDisplayInfo("Name_example", "Language_example", false)} // []DisplayInfo | (optional) 964 965 configuration := openapiclient.NewConfiguration() 966 api_client := openapiclient.NewAPIClient(configuration) 967 resp, r, err := api_client.GeographyApi.UpdatePoint(context.Background(), pointId).DisplayInfo(displayInfo).Execute() 968 if err.Error() != "" { 969 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.UpdatePoint``: %v\n", err) 970 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 971 } 972 // response from `UpdatePoint`: SinglePoint 973 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.UpdatePoint`: %v\n", resp) 974 } 975 ``` 976 977 ### Path Parameters 978 979 980 Name | Type | Description | Notes 981 ------------- | ------------- | ------------- | ------------- 982 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 983 **pointId** | **string** | | 984 985 ### Other Parameters 986 987 Other parameters are passed through a pointer to a apiUpdatePointRequest struct via the builder pattern 988 989 990 Name | Type | Description | Notes 991 ------------- | ------------- | ------------- | ------------- 992 993 **displayInfo** | [**[]DisplayInfo**](DisplayInfo.md) | | 994 995 ### Return type 996 997 [**SinglePoint**](SinglePoint.md) 998 999 ### Authorization 1000 1001 [bearerAuth](../README.md#bearerAuth) 1002 1003 ### HTTP request headers 1004 1005 - **Content-Type**: application/json 1006 - **Accept**: application/json 1007 1008 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 1009 [[Back to Model list]](../README.md#documentation-for-models) 1010 [[Back to README]](../README.md) 1011 1012 1013 ## UpdateRoute 1014 1015 > SingleRoute UpdateRoute(ctx, routeId).DisplayInfo(displayInfo).Execute() 1016 1017 1018 1019 ### Example 1020 1021 ```go 1022 package main 1023 1024 import ( 1025 "context" 1026 "fmt" 1027 "os" 1028 openapiclient "./openapi" 1029 ) 1030 1031 func main() { 1032 routeId := "routeId_example" // string | 1033 displayInfo := []openapiclient.DisplayInfo{*openapiclient.NewDisplayInfo("Name_example", "Language_example", false)} // []DisplayInfo | (optional) 1034 1035 configuration := openapiclient.NewConfiguration() 1036 api_client := openapiclient.NewAPIClient(configuration) 1037 resp, r, err := api_client.GeographyApi.UpdateRoute(context.Background(), routeId).DisplayInfo(displayInfo).Execute() 1038 if err.Error() != "" { 1039 fmt.Fprintf(os.Stderr, "Error when calling `GeographyApi.UpdateRoute``: %v\n", err) 1040 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 1041 } 1042 // response from `UpdateRoute`: SingleRoute 1043 fmt.Fprintf(os.Stdout, "Response from `GeographyApi.UpdateRoute`: %v\n", resp) 1044 } 1045 ``` 1046 1047 ### Path Parameters 1048 1049 1050 Name | Type | Description | Notes 1051 ------------- | ------------- | ------------- | ------------- 1052 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1053 **routeId** | **string** | | 1054 1055 ### Other Parameters 1056 1057 Other parameters are passed through a pointer to a apiUpdateRouteRequest struct via the builder pattern 1058 1059 1060 Name | Type | Description | Notes 1061 ------------- | ------------- | ------------- | ------------- 1062 1063 **displayInfo** | [**[]DisplayInfo**](DisplayInfo.md) | | 1064 1065 ### Return type 1066 1067 [**SingleRoute**](SingleRoute.md) 1068 1069 ### Authorization 1070 1071 [bearerAuth](../README.md#bearerAuth) 1072 1073 ### HTTP request headers 1074 1075 - **Content-Type**: application/json 1076 - **Accept**: application/json 1077 1078 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 1079 [[Back to Model list]](../README.md#documentation-for-models) 1080 [[Back to README]](../README.md) 1081