@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
395 lines (394 loc) • 8.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DNSimple contact resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* // Create a contact
* const me = new dnsimple.Contact("me", {
* label: "Apple Appleseed",
* firstName: "Apple",
* lastName: "Appleseed",
* organizationName: "Contoso",
* jobTitle: "Manager",
* address1: "Level 1, 2 Main St",
* address2: "Marsfield",
* city: "San Francisco",
* stateProvince: "California",
* postalCode: "90210",
* country: "US",
* phone: "+1401239523",
* fax: "+1849491024",
* email: "apple@contoso.com",
* });
* ```
*
* ## Import
*
* DNSimple contacts can be imported using their numeric ID.
*
* bash
*
* ```sh
* $ pulumi import dnsimple:index/contact:Contact resource_name 5678
* ```
*
* The ID can be found within [DNSimple Contacts API](https://developer.dnsimple.com/v2/contacts/#listContacts). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
*
* bash
*
* curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1234/contacts?label_like=example.com | jq
*
* {
*
* "data": [
*
* {
*
* "id": 1,
*
* "account_id": 1010,
*
* "label": "Default",
*
* "first_name": "First",
*
* "last_name": "User",
*
* "job_title": "CEO",
*
* "organization_name": "Awesome Company",
*
* "email": "first@example.com",
*
* "phone": "+18001234567",
*
* "fax": "+18011234567",
*
* "address1": "Italian Street, 10",
*
* "address2": "",
*
* "city": "Roma",
*
* "state_province": "RM",
*
* "postal_code": "00100",
*
* "country": "IT",
*
* "created_at": "2013-11-08T17:23:15Z",
*
* "updated_at": "2015-01-08T21:30:50Z"
*
* },
*
* {
*
* "id": 2,
*
* "account_id": 1010,
*
* "label": "",
*
* "first_name": "Second",
*
* "last_name": "User",
*
* "job_title": "",
*
* "organization_name": "",
*
* "email": "second@example.com",
*
* "phone": "+18881234567",
*
* "fax": "",
*
* "address1": "French Street",
*
* "address2": "c/o Someone",
*
* "city": "Paris",
*
* "state_province": "XY",
*
* "postal_code": "00200",
*
* "country": "FR",
*
* "created_at": "2014-12-06T15:46:18Z",
*
* "updated_at": "2014-12-06T15:46:18Z"
*
* }
*
* ],
*
* "pagination": {
*
* "current_page": 1,
*
* "per_page": 30,
*
* "total_entries": 2,
*
* "total_pages": 1
*
* }
*
* }
*/
export declare class Contact extends pulumi.CustomResource {
/**
* Get an existing Contact resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ContactState, opts?: pulumi.CustomResourceOptions): Contact;
/**
* Returns true if the given object is an instance of Contact. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Contact;
/**
* The account ID for the contact.
*/
readonly accountId: pulumi.Output<number>;
/**
* Address line 1
*/
readonly address1: pulumi.Output<string>;
/**
* Address line 2
*/
readonly address2: pulumi.Output<string>;
/**
* City
*/
readonly city: pulumi.Output<string>;
/**
* Country
*/
readonly country: pulumi.Output<string>;
/**
* Timestamp representing when this contact was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Email
*
* # Attributes Reference
*/
readonly email: pulumi.Output<string>;
/**
* Fax
*/
readonly fax: pulumi.Output<string>;
/**
* The fax number, normalized.
*/
readonly faxNormalized: pulumi.Output<string>;
/**
* First name
*/
readonly firstName: pulumi.Output<string>;
/**
* Job title
*/
readonly jobTitle: pulumi.Output<string>;
/**
* Label
*/
readonly label: pulumi.Output<string>;
/**
* Last name
*/
readonly lastName: pulumi.Output<string>;
/**
* Organization name
*/
readonly organizationName: pulumi.Output<string>;
/**
* Phone
*/
readonly phone: pulumi.Output<string>;
/**
* The phone number, normalized.
*/
readonly phoneNormalized: pulumi.Output<string>;
/**
* Postal code
*/
readonly postalCode: pulumi.Output<string>;
/**
* State province
*/
readonly stateProvince: pulumi.Output<string>;
/**
* Timestamp representing when this contact was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Contact resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ContactArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Contact resources.
*/
export interface ContactState {
/**
* The account ID for the contact.
*/
accountId?: pulumi.Input<number>;
/**
* Address line 1
*/
address1?: pulumi.Input<string>;
/**
* Address line 2
*/
address2?: pulumi.Input<string>;
/**
* City
*/
city?: pulumi.Input<string>;
/**
* Country
*/
country?: pulumi.Input<string>;
/**
* Timestamp representing when this contact was created.
*/
createdAt?: pulumi.Input<string>;
/**
* Email
*
* # Attributes Reference
*/
email?: pulumi.Input<string>;
/**
* Fax
*/
fax?: pulumi.Input<string>;
/**
* The fax number, normalized.
*/
faxNormalized?: pulumi.Input<string>;
/**
* First name
*/
firstName?: pulumi.Input<string>;
/**
* Job title
*/
jobTitle?: pulumi.Input<string>;
/**
* Label
*/
label?: pulumi.Input<string>;
/**
* Last name
*/
lastName?: pulumi.Input<string>;
/**
* Organization name
*/
organizationName?: pulumi.Input<string>;
/**
* Phone
*/
phone?: pulumi.Input<string>;
/**
* The phone number, normalized.
*/
phoneNormalized?: pulumi.Input<string>;
/**
* Postal code
*/
postalCode?: pulumi.Input<string>;
/**
* State province
*/
stateProvince?: pulumi.Input<string>;
/**
* Timestamp representing when this contact was updated.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Contact resource.
*/
export interface ContactArgs {
/**
* Address line 1
*/
address1: pulumi.Input<string>;
/**
* Address line 2
*/
address2?: pulumi.Input<string>;
/**
* City
*/
city: pulumi.Input<string>;
/**
* Country
*/
country: pulumi.Input<string>;
/**
* Email
*
* # Attributes Reference
*/
email: pulumi.Input<string>;
/**
* Fax
*/
fax?: pulumi.Input<string>;
/**
* First name
*/
firstName: pulumi.Input<string>;
/**
* Job title
*/
jobTitle?: pulumi.Input<string>;
/**
* Label
*/
label?: pulumi.Input<string>;
/**
* Last name
*/
lastName: pulumi.Input<string>;
/**
* Organization name
*/
organizationName?: pulumi.Input<string>;
/**
* Phone
*/
phone: pulumi.Input<string>;
/**
* Postal code
*/
postalCode: pulumi.Input<string>;
/**
* State province
*/
stateProvince: pulumi.Input<string>;
}