sample config files

Author: adambyer

config-custom/Sample.custom.json

@@ -0,0 +1,81 @@
+{
+	"global": {
+		"parameter_maps": {
+			"refresh_token": "REFRESH-TOKEN"
+		},
+		"set": {
+			"endpoint_prerequisites": [
+				{
+					"endpoint": "refresh_token",
+					"repeat": false,
+					"merge_maps": {
+						"access_token": "ACCESS-TOKEN"
+					}
+				}
+			]
+		}
+	},
+	"common_endpoint_settings": {
+		"all": {
+			"time_limit": 60
+		}
+	},
+	"endpoints": {
+		"pull_user_feed": {
+			"maps_to": "get_user_feed",
+			"parameters": {
+				"limit": 20
+			},
+			"output": {
+				"data": {
+					"format": "iterable",
+					"location": ["data"]
+				},
+				"filter": [
+					{
+						"search_key": "name",
+						"search_value": "*|NAME|*",
+						"return_key": "text"
+					}
+				]
+			}
+		},
+		"pull_clients": {
+			"maps_to": "clients",
+			"output": {
+				"data": {
+					"items": {
+						"locations": {
+							"id": "ClientID",
+							"name": "Name"
+						}
+					}
+				}
+			}
+		},
+		"pull_list_count": {
+			"maps_to": "list_stats",
+			"parameter_maps": {
+				"list_id": "LIST-ID"
+			},
+			"output": {
+				"data" : {
+					"location": ["Total"]
+				}
+			}
+		},
+		"push_list_contacts": {
+			"maps_to": "add_contacts",
+			"parameter_maps": {
+				"contacts": "Members",
+				"list_id": "LIST-ID"
+			},
+			"array_set_templates": {
+				"Members": {
+					"EmailAddress": "email_address",
+					"Name": "full_name"
+				}
+			}
+		}
+	}
+}

config/Sample.json

@@ -0,0 +1,87 @@
+{
+	"base_uri": "https://some.api.com/",
+	"authentication": {
+		"steps": [
+			{
+				"type": "redirect",
+				"uri": "https://some.api.com/oauth",
+				"parameters": {
+					"client_id": "*|CLIENT-ID|*",
+					"redirect_uri": "*|REDIRECT-URI|*"
+				}
+			},
+			{
+				"type": "endpoint",
+				"endpoint": "access_token"
+			}
+		]
+	},
+	"common_endpoint_settings": {
+		"all": {
+			"output_format": "json",
+			"request_options": {
+				"headers": {
+					"Content-type": "application/x-www-form-urlencoded",
+					"Accept": "application/json"
+				}
+			},
+			"parameters": {
+				"access_token": "*|ACCESS-TOKEN|*"
+			}
+		}
+	},
+	"endpoints": {
+		"access_token": {
+			"uri": "oauth/access_token",
+			"method": "get",
+			"parameters": {
+				"client_id": "*|CLIENT-ID|*",
+				"client_secret": "*|CLIENT-SECRET|*",
+				"redirect_uri": "*|REDIRECT-URI|*",
+				"code": null,
+				"access_token": null
+			}
+		},
+		"get_user": {
+			"uri": "*|USER-ID|*",
+			"method": "get"
+		},
+		"get_lists": {
+			"uri": "lists/list.json",
+			"paging": {
+				"type": "page_number",
+				"parameters": {
+					"page_size": {
+						"name": "limit"
+					},
+					"page_number": {
+						"name": "start",
+						"base": 0
+					}
+				}
+			}
+		},
+		"add_users": {
+			"uri": "users/add.json",
+			"method": "post",
+			"parameters": {
+				"id": null,
+				"batch": null
+			},
+			"parameter_format": {
+				"batch": [
+					{
+						"email": {
+							"email": null
+						},
+						"email_type": null,
+						"merge_vars": {
+							"FNAME": null,
+							"LNAME": null
+						}
+					}
+				]
+			}
+		}
+	}
+}