Add organization and inventory claim resources

Author: danischm

docs/resources/network_device_claim.md

@@ -0,0 +1,32 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "meraki_network_device_claim Resource - terraform-provider-meraki"
+subcategory: "Networks"
+description: |-
+  This resource allows claiming and removing serials to a network. It will not not touch any existing serials already claimed and not included in serials. Removing a serial from a network will return it to the organization inventory.
+---
+
+# meraki_network_device_claim (Resource)
+
+This resource allows claiming and removing serials to a network. It will not not touch any existing serials already claimed and not included in `serials`. Removing a serial from a network will return it to the organization inventory.
+
+## Example Usage
+
+```terraform
+resource "meraki_network_device_claim" "example" {
+  network_id = "123456"
+  serials    = ["1234-1234-1234"]
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `network_id` (String) Netowrk ID
+- `serials` (Set of String) A list of serials of devices to claim
+
+### Read-Only
+
+- `id` (String) The id of the object

docs/resources/organization_inventory_claim.md

@@ -0,0 +1,32 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "meraki_organization_inventory_claim Resource - terraform-provider-meraki"
+subcategory: "Organizations"
+description: |-
+  This resource allows claiming and releasing serials from the organization inventory. It will not not touch any existing serials already claimed and not included in serials.
+---
+
+# meraki_organization_inventory_claim (Resource)
+
+This resource allows claiming and releasing serials from the organization inventory. It will not not touch any existing serials already claimed and not included in `serials`.
+
+## Example Usage
+
+```terraform
+resource "meraki_organization_inventory_claim" "example" {
+  organization_id = "123456"
+  serials         = ["1234-1234-1234"]
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `organization_id` (String) Organization ID
+- `serials` (Set of String) The list of serials to be claimed to the organization
+
+### Read-Only
+
+- `id` (String) The id of the object

examples/resources/meraki_network_device_claim/resource.tf

@@ -0,0 +1,4 @@
+resource "meraki_network_device_claim" "example" {
+  network_id = "123456"
+  serials    = ["1234-1234-1234"]
+}

examples/resources/meraki_organization_inventory_claim/resource.tf

@@ -0,0 +1,4 @@
+resource "meraki_organization_inventory_claim" "example" {
+  organization_id = "123456"
+  serials         = ["1234-1234-1234"]
+}

gen/definitions/network_device_claim.yaml

@@ -0,0 +1,37 @@
+---
+name: Network Device Claim
+rest_endpoint: /networks/%v/devices/claim
+no_data_source: true
+no_import: true
+doc_category: Networks
+test_tags: [TF_VAR_CLAIM_SERIAL_1, TF_VAR_CLAIM_SERIAL_2]
+res_description: This resource allows claiming and removing serials to a network. It will not not touch any existing serials already claimed and not included in `serials`. Removing a serial from a network will return it to the organization inventory.
+attributes:
+  - tf_name: network_id
+    type: String
+    reference: true
+    id: true
+    description: Netowrk ID
+    example: 123456
+    test_value: meraki_network.test.id
+  - model_name: serials
+    type: Set
+    element_type: String
+    mandatory: true
+    description: A list of serials of devices to claim
+    example: 1234-1234-1234
+    test_value: "[var.CLAIM_SERIAL_1]"
+
+test_prerequisites: |
+  variable "CLAIM_SERIAL_1" {}
+  variable "CLAIM_SERIAL_2" {}
+
+  data "meraki_organization" "test" {
+    name = "Dev"
+  }
+
+  resource "meraki_network" "test" {
+    organization_id = data.meraki_organization.test.id
+    name            = "Network1"
+    product_types   = ["appliance", "switch", "wireless"]
+  }

gen/definitions/organization_inventory_claim.yaml

@@ -0,0 +1,31 @@
+---
+name: Organization Inventory Claim
+rest_endpoint: /organizations/%v/inventory/claim
+no_data_source: true
+no_import: true
+doc_category: Organizations
+test_tags: [TF_VAR_CLAIM_SERIAL_1, TF_VAR_CLAIM_SERIAL_2]
+res_description: This resource allows claiming and releasing serials from the organization inventory. It will not not touch any existing serials already claimed and not included in `serials`.
+attributes:
+  - tf_name: organization_id
+    type: String
+    reference: true
+    id: true
+    description: Organization ID
+    example: 123456
+    test_value: data.meraki_organization.test.id
+  - model_name: serials
+    type: Set
+    element_type: String
+    mandatory: true
+    description: The list of serials to be claimed to the organization
+    example: 1234-1234-1234
+    test_value: "[var.CLAIM_SERIAL_1]"
+
+test_prerequisites: |
+  variable "CLAIM_SERIAL_1" {}
+  variable "CLAIM_SERIAL_2" {}
+
+  data "meraki_organization" "test" {
+    name = "Dev"
+  }

gen/schema/schema.yaml

@@ -15,7 +15,7 @@ res_description: str(required=False) # Define a resource description
 doc_category: str(required=False) # Define a documentation category
 skip_minimum_test: bool(required=False) # Do not perform a "minimum" (only mandatory attributes) test
 attributes: list(include('attribute'), required=False) # List of attributes
-test_tags: list(str(), required=False) # List of test tags, tests are only executed if an environment variable with one of these tags is configured
+test_tags: list(str(), required=False) # List of test tags, tests are only executed if an environment variable with for each of these tags is configured
 test_prerequisites: str(required=False) # HCL code that is included in the acceptance tests to define prerequisites
 ---
 attribute:

gen/templates/data_source_test.go

@@ -31,7 +31,7 @@ import (
 
 func TestAccDataSourceMeraki{{camelCase .Name}}(t *testing.T) {
 	{{- if len .TestTags}}
-	if {{range $i, $e := .TestTags}}{{if $i}} && {{end}}os.Getenv("{{$e}}") == ""{{end}} {
+	if {{range $i, $e := .TestTags}}{{if $i}} || {{end}}os.Getenv("{{$e}}") == ""{{end}} {
         t.Skip("skipping test, set environment variable {{range $i, $e := .TestTags}}{{if $i}} or {{end}}{{$e}}{{end}}")
 	}
 	{{- end}}

gen/templates/resource_test.go

@@ -31,7 +31,7 @@ import (
 
 func TestAccMeraki{{camelCase .Name}}(t *testing.T) {
 	{{- if len .TestTags}}
-	if {{range $i, $e := .TestTags}}{{if $i}} && {{end}}os.Getenv("{{$e}}") == ""{{end}} {
+	if {{range $i, $e := .TestTags}}{{if $i}} || {{end}}os.Getenv("{{$e}}") == ""{{end}} {
         t.Skip("skipping test, set environment variable {{range $i, $e := .TestTags}}{{if $i}} or {{end}}{{$e}}{{end}}")
 	}
 	{{- end}}

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/hashicorp/terraform-plugin-go v0.23.0
 	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-testing v1.10.0
-	github.com/netascode/go-meraki v0.0.0-20240901102824-a67592c39438
+	github.com/netascode/go-meraki v0.0.0-20240912063604-fb6bdcff45e5
 	github.com/tidwall/gjson v1.17.3
 	github.com/tidwall/sjson v1.2.5
 	golang.org/x/tools v0.25.0
@@ -88,7 +88,7 @@ require (
 	golang.org/x/text v0.18.0 // indirect
 	google.golang.org/appengine v1.6.8 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 // indirect
-	google.golang.org/grpc v1.66.1 // indirect
+	google.golang.org/grpc v1.66.2 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v2 v2.3.0 // indirect
 )

go.sum

@@ -164,8 +164,8 @@ github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RR
 github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
 github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ=
 github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw=
-github.com/netascode/go-meraki v0.0.0-20240901102824-a67592c39438 h1:dsFYRJ2aXEddmIz76weQAZ6QzliSmMpVaZxGlW4wTUA=
-github.com/netascode/go-meraki v0.0.0-20240901102824-a67592c39438/go.mod h1:xZ/kiJA+SZY32p5t1J9Jdhvtig9BU4SMbxKnfAJrmLE=
+github.com/netascode/go-meraki v0.0.0-20240912063604-fb6bdcff45e5 h1:Jt2mPdO+cReX7ClLo++GN4GkHFl9zHllSt4I1+FWzKE=
+github.com/netascode/go-meraki v0.0.0-20240912063604-fb6bdcff45e5/go.mod h1:xZ/kiJA+SZY32p5t1J9Jdhvtig9BU4SMbxKnfAJrmLE=
 github.com/oklog/run v1.1.0 h1:GEenZ1cK0+q0+wsJew9qUg/DyD8k3JzYsZAi5gYi2mA=
 github.com/oklog/run v1.1.0/go.mod h1:sVPdnTZT1zYwAJeCMu2Th4T21pA3FPOQRfWjQlk7DVU=
 github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4=
@@ -285,6 +285,8 @@ google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1 h1:
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240903143218-8af14fe29dc1/go.mod h1:UqMtugtsSgubUsoxbuAoiCXvqvErP7Gf0so0mK9tHxU=
 google.golang.org/grpc v1.66.1 h1:hO5qAXR19+/Z44hmvIM4dQFMSYX9XcWsByfoxutBpAM=
 google.golang.org/grpc v1.66.1/go.mod h1:s3/l6xSSCURdVfAnL+TqCNMyTDAGN6+lZeVxnZR128Y=
+google.golang.org/grpc v1.66.2 h1:3QdXkuq3Bkh7w+ywLdLvM56cmGvQHUMZpiCzt6Rqaoo=
+google.golang.org/grpc v1.66.2/go.mod h1:s3/l6xSSCURdVfAnL+TqCNMyTDAGN6+lZeVxnZR128Y=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg=

internal/provider/model_meraki_network_device_claim.go

@@ -0,0 +1,100 @@
+// Copyright © 2024 Cisco Systems, Inc. and its affiliates.
+// All rights reserved.
+//
+// Licensed under the Mozilla Public License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://mozilla.org/MPL/2.0/
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package provider
+
+// Section below is generated&owned by "gen/generator.go". //template:begin imports
+import (
+	"context"
+	"fmt"
+	"net/url"
+
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/netascode/terraform-provider-meraki/internal/provider/helpers"
+	"github.com/tidwall/gjson"
+	"github.com/tidwall/sjson"
+)
+
+// End of section. //template:end imports
+
+// Section below is generated&owned by "gen/generator.go". //template:begin types
+
+type NetworkDeviceClaim struct {
+	Id        types.String `tfsdk:"id"`
+	NetworkId types.String `tfsdk:"network_id"`
+	Serials   types.Set    `tfsdk:"serials"`
+}
+
+// End of section. //template:end types
+
+// Section below is generated&owned by "gen/generator.go". //template:begin getPath
+
+func (data NetworkDeviceClaim) getPath() string {
+	return fmt.Sprintf("/networks/%v/devices/claim", url.QueryEscape(data.NetworkId.ValueString()))
+}
+
+// End of section. //template:end getPath
+
+func (data NetworkDeviceClaim) getRemovePath() string {
+	return fmt.Sprintf("/networks/%v/devices/remove", url.QueryEscape(data.NetworkId.ValueString()))
+}
+
+func (data NetworkDeviceClaim) getDevicesPath() string {
+	return fmt.Sprintf("/networks/%v/devices", url.QueryEscape(data.NetworkId.ValueString()))
+}
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toBody
+
+func (data NetworkDeviceClaim) toBody(ctx context.Context, state NetworkDeviceClaim) string {
+	body := ""
+	if !data.Serials.IsNull() {
+		var values []string
+		data.Serials.ElementsAs(ctx, &values, false)
+		body, _ = sjson.Set(body, "serials", values)
+	}
+	return body
+}
+
+// End of section. //template:end toBody
+
+// Section below is generated&owned by "gen/generator.go". //template:begin fromBody
+
+func (data *NetworkDeviceClaim) fromBody(ctx context.Context, res gjson.Result) {
+	if value := res.Get("serials"); value.Exists() {
+		data.Serials = helpers.GetStringSet(value.Array())
+	} else {
+		data.Serials = types.SetNull(types.StringType)
+	}
+}
+
+// End of section. //template:end fromBody
+
+// Section below is generated&owned by "gen/generator.go". //template:begin fromBodyPartial
+
+// fromBodyPartial reads values from a gjson.Result into a tfstate model. It ignores null attributes in order to
+// uncouple the provider from the exact values that the backend API might summon to replace nulls. (Such behavior might
+// easily change across versions of the backend API.) For List/Set/Map attributes, the func only updates the
+// "managed" elements, instead of all elements.
+func (data *NetworkDeviceClaim) fromBodyPartial(ctx context.Context, res gjson.Result) {
+	if value := res.Get("serials"); value.Exists() && !data.Serials.IsNull() {
+		data.Serials = helpers.GetStringSet(value.Array())
+	} else {
+		data.Serials = types.SetNull(types.StringType)
+	}
+}
+
+// End of section. //template:end fromBodyPartial