organizations

type AddressNewParams struct {
	// City or locality.
	City string `json:"city" api:"required"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country string `json:"country" api:"required"`
	// First line of the street address.
	Line1 string `json:"line1" api:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" api:"required"`
	// Second line of the street address (suite, unit, building).
	Line2 param.Opt[string] `json:"line2,omitzero"`
	// State, province, or region. Required by some tax jurisdictions (e.g. US, CA).
	State param.Opt[string] `json:"state,omitzero"`
	// Tax identification number (e.g. VAT, EIN, ABN). Optional.
	TaxID param.Opt[string] `json:"tax_id,omitzero"`
	// Type of the tax identification number (e.g. eu_vat, us_ein, gb_vat, au_abn).
	// Optional.
	TaxIDType param.Opt[string] `json:"tax_id_type,omitzero"`
	// contains filtered or unexported fields
}

type AddressService struct {
	Options []option.RequestOption
}

type AddressUpdateParams struct {
	// Second line of the street address (suite, unit, building). Omit to leave
	// unchanged, send null to clear, or send a value to set it.
	Line2 param.Opt[string] `json:"line2,omitzero"`
	// State, province, or region. Omit to leave unchanged, send null to clear, or send
	// a value to set it.
	State param.Opt[string] `json:"state,omitzero"`
	// Tax identification number (e.g. VAT, EIN, ABN). Omit to leave unchanged, send
	// null to clear, or send a value to set it.
	TaxID param.Opt[string] `json:"tax_id,omitzero"`
	// Type of the tax identification number (e.g. eu_vat, us_ein, gb_vat, au_abn).
	// Omit to leave unchanged, send null to clear, or send a value to set it.
	TaxIDType param.Opt[string] `json:"tax_id_type,omitzero"`
	// City or locality.
	City param.Opt[string] `json:"city,omitzero"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country param.Opt[string] `json:"country,omitzero"`
	// First line of the street address.
	Line1 param.Opt[string] `json:"line1,omitzero"`
	// Postal or ZIP code.
	PostalCode param.Opt[string] `json:"postal_code,omitzero"`
	// contains filtered or unexported fields
}

type Error = apierror.Error

type MembershipListParams struct {
	// Pagination cursor returned by a previous request
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of items to return
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

type MembershipService struct {
	Options []option.RequestOption
}

type Organization struct {
	// Organization ID.
	ID string `json:"id" api:"required"`
	// Billing email. Null when no custom billing email is set (reverts to the oldest
	// owner's email).
	BillingEmail string `json:"billing_email" api:"required"`
	// When the Organization was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Domains associated with the organization.
	Domains []OrganizationDomain `json:"domains" api:"required"`
	// Metronome customer ID.
	MetronomeCustomerID string `json:"metronome_customer_id" api:"required"`
	// Organization name.
	Name string `json:"name" api:"required"`
	// Whether the organization is a personal Organization.
	Personal bool `json:"personal" api:"required"`
	// Services that the Organization has access to.
	Services OrganizationServices `json:"services" api:"required"`
	// Stripe customer ID.
	StripeCustomerID string `json:"stripe_customer_id" api:"required"`
	// Organization type.
	//
	// Any of "personal", "company".
	Type OrganizationType `json:"type" api:"required"`
	// When the Organization was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Authentication provider organization ID.
	AuthID string `json:"auth_id"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                  respjson.Field
		BillingEmail        respjson.Field
		CreatedAt           respjson.Field
		Domains             respjson.Field
		MetronomeCustomerID respjson.Field
		Name                respjson.Field
		Personal            respjson.Field
		Services            respjson.Field
		StripeCustomerID    respjson.Field
		Type                respjson.Field
		UpdatedAt           respjson.Field
		AuthID              respjson.Field
		ExtraFields         map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationAddress struct {
	// Address ID.
	ID string `json:"id" api:"required"`
	// City or locality.
	City string `json:"city" api:"required"`
	// Two-letter ISO 3166-1 alpha-2 country code.
	Country string `json:"country" api:"required"`
	// When the address was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// First line of the street address.
	Line1 string `json:"line1" api:"required"`
	// Second line of the street address. Null when not provided.
	Line2 string `json:"line2" api:"required"`
	// Organization ID the address belongs to.
	OrganizationID string `json:"organization_id" api:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" api:"required"`
	// State, province, or region. Null when not provided.
	State string `json:"state" api:"required"`
	// Tax identification number. Null when not provided.
	TaxID string `json:"tax_id" api:"required"`
	// Type of the tax identification number. Null when not provided.
	TaxIDType string `json:"tax_id_type" api:"required"`
	// When the address was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		City           respjson.Field
		Country        respjson.Field
		CreatedAt      respjson.Field
		Line1          respjson.Field
		Line2          respjson.Field
		OrganizationID respjson.Field
		PostalCode     respjson.Field
		State          respjson.Field
		TaxID          respjson.Field
		TaxIDType      respjson.Field
		UpdatedAt      respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationDomain struct {
	// Domain ID.
	ID string `json:"id" api:"required"`
	// Domain name.
	Domain string `json:"domain" api:"required"`
	// Whether the domain has been verified.
	Verified bool `json:"verified" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Domain      respjson.Field
		Verified    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationList struct {
	Items []Organization `json:"items" api:"required"`
	// Pagination response details.
	Pagination shared.Pagination `json:"pagination" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Items       respjson.Field
		Pagination  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationListParams struct {
	// Pagination cursor returned by a previous request
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of items to return
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

type OrganizationMembership struct {
	// Membership ID.
	ID string `json:"id" api:"required"`
	// When the membership was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Organization ID.
	OrganizationID string `json:"organization_id" api:"required"`
	// Role of the user in the organization.
	//
	// Any of "owner", "member".
	Role OrganizationMembershipRole `json:"role" api:"required"`
	// When the membership was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// User ID.
	UserID string `json:"user_id" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreatedAt      respjson.Field
		OrganizationID respjson.Field
		Role           respjson.Field
		UpdatedAt      respjson.Field
		UserID         respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationMembershipList struct {
	Items []OrganizationMembership `json:"items" api:"required"`
	// Pagination response details.
	Pagination shared.Pagination `json:"pagination" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Items       respjson.Field
		Pagination  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationMembershipRole string

type OrganizationNewParams struct {
	// Organization name.
	Name string `json:"name" api:"required"`
	// Optional billing email. When omitted, the oldest owner's email is used.
	BillingEmail param.Opt[string] `json:"billing_email,omitzero"`
	// contains filtered or unexported fields
}

type OrganizationService struct {
	Options     []option.RequestOption
	Memberships MembershipService
	Address     AddressService
}

type OrganizationServices struct {
	// Whether cloud services are enabled for the organization.
	Cloud bool `json:"cloud" api:"required"`
	// Whether just-in-time provisioning is enabled for the organization.
	JitProvisioning bool `json:"jit_provisioning" api:"required"`
	// Whether SCIM provisioning is enabled for the organization.
	SCIM bool `json:"scim" api:"required"`
	// Whether SIEM integration is enabled for the organization.
	SIEM bool `json:"siem" api:"required"`
	// Whether single sign-on is enabled for the organization.
	SSO bool `json:"sso" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Cloud           respjson.Field
		JitProvisioning respjson.Field
		SCIM            respjson.Field
		SIEM            respjson.Field
		SSO             respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type OrganizationType string

type OrganizationUpdateParams struct {
	// Billing email. Omit to leave unchanged, send null to clear (reverts to the
	// oldest owner's email), or send a value to set it.
	BillingEmail param.Opt[string] `json:"billing_email,omitzero"`
	// Organization name.
	Name param.Opt[string] `json:"name,omitzero"`
	// contains filtered or unexported fields
}

type Pagination = shared.Pagination

type RegionName = shared.RegionName

type ResourceStatus = shared.ResourceStatus

type SourceIPRuleParam = shared.SourceIPRuleParam

type SourceIPRuleResponse = shared.SourceIPRuleResponse