dnsimple v0.9.2 Dnsimple.Services

This module provides functions to interact with the service related endpoints.

See https://developer.dnsimple.com/v2/services See https://developer.dnsimple.com/v2/services/domains/

Summary

Functions

applied_services(client, account_id, domain_id, options \\ [])

Lists the services already applied to a domain

apply_service(client, account_id, domain_id, service_id, options \\ [])

Apply a service to a domain

get_service(client, service_id, options \\ [])

Returns a service

list_services(client, options \\ [])

Returns the list of existing services

service(client, service_id)

See Dnsimple.Services.get_service/2

service(client, service_id, options)

See Dnsimple.Services.get_service/3

services(client)

See Dnsimple.Services.list_services/1

services(client, options)

See Dnsimple.Services.list_services/2

unapply_service(client, account_id, domain_id, service_id, options \\ [])

Unapply a service previously applied to a domain

Functions

applied_services(client, account_id, domain_id, options \\ [])

Specs

applied_services(Dnsimple.Client.t, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Lists the services already applied to a domain.

See https://developer.dnsimple.com/v2/services/domains/#applied

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”}

Dnsimple.Services.applied_services(client, account_id = 1010, domain_id = “example.com”) Dnsimple.Services.applied_services(client, account_id = 1010, domain_id = “example.com”, page: 2)

apply_service(client, account_id, domain_id, service_id, options \\ [])

Specs

apply_service(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Apply a service to a domain.

See https://developer.dnsimple.com/v2/services/domains/#apply

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”}

Dnsimple.Services.apply_service(client, account_id = 1010, domain_id = “example.com”, service_id = 12)

get_service(client, service_id, options \\ [])

Specs

get_service(Dnsimple.Client.t, integer | String.t, Keyword.t) :: Dnsimple.Response.t

Returns a service.

See https://developer.dnsimple.com/v2/services/#get

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”}

Dnsimple.Templates.get_service(client, service_id = 1) Dnsimple.Templates.get_service(client, service_id = “wordpress”)

list_services(client, options \\ [])

Specs

list_services(Dnsimple.Client.t, Keyword.t) :: Dnsimple.Response.t

Returns the list of existing services.

See https://developer.dnsimple.com/v2/services/#list

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”}

Dnsimple.Templates.list_services(client) Dnsimple.Templates.list_services(client, sort: “short_name:desc”)

service(client, service_id)

See Dnsimple.Services.get_service/2.

service(client, service_id, options)

Specs

service(Dnsimple.Client.t, integer | String.t, Keyword.t) :: Dnsimple.Response.t

See Dnsimple.Services.get_service/3.

services(client)

See Dnsimple.Services.list_services/1.

services(client, options)

Specs

services(Dnsimple.Client.t, Keyword.t) :: Dnsimple.Response.t

See Dnsimple.Services.list_services/2.

unapply_service(client, account_id, domain_id, service_id, options \\ [])

Specs

unapply_service(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Unapply a service previously applied to a domain.

See https://developer.dnsimple.com/v2/services/domains/#unapply

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”}

Dnsimple.Services.unapply_service(client, account_id = 1010, domain_id = “example.com”, service_id = 12)